add proc-macro

MoAlyousef · MoAlyousef · commit 88262b0f891b · 2022-11-22T10:30:24.000+03:00
diff --git a/README.md b/README.md
@@ -18,7 +18,54 @@ Then run:
 $ fl2rust <fl file>.fl > <output file>.rs
 ```
 
-### As a library
+### As a proc-macro
+Add fl2rust-macro to your list of dependencies:
+```toml
+# Cargo.toml
+[dependencies]
+fltk = "1"
+fl2rust-macro = "0.5"
+```
+
+The ui file that's generated by fluid, we'll name it myuifile.fl and keep it in our src directory:
+```
+# data file for the Fltk User Interface Designer (fluid)
+version 1.0400
+header_name {.h}
+code_name {.cxx}
+class UserInterface {open
+} {
+  Function {make_window()} {open
+  } {
+    Fl_Window {} {open selected
+      xywh {138 161 440 355} type Double visible
+    } {
+      Fl_Button but {
+        label {Click me}
+        xywh {175 230 95 45}
+      }
+    }
+  }
+}
+```
+
+In our main source file:
+```rust
+use fltk::{prelude::*, *};
+
+mod ui {
+    fl2rust_macro::include_ui!("src/myui.fl");
+}
+
+fn main() {
+    let a = app::App::default();
+    let mut ui = ui::UserInterface::make_window();
+    ui.but.set_callback(|b| println!("Button clicked!"));
+    a.run().unwrap();
+}
+```
+
+### As a dev-dependency
 
 (A template repo usable via [cargo-generate](https://crates.io/crates/cargo-generate) can be found [here](https://github.com/fltk-rs/fl2rust-template))
 
@@ -45,8 +92,8 @@ fn main() {
 }
 ```
 
+The ui file that's generated by fluid, we'll name it myuifile.fl and keep it in our src directory:
 ```
-# src/myuifile.fl -> generated via fluid
 # data file for the Fltk User Interface Designer (fluid)
 version 1.0400
 header_name {.h}
@@ -113,7 +160,6 @@ extern crate tr;
 - Initialize tr as described in the tr crate's documentation.
 
 ## Known limitations
-- Adding arbitrary code or declaring global/member variables is unsupported.
 - Only constructor methods are supported.
 - fl2rust doesn't check the generated Rust code for correctness.
 
diff --git a/examples/devdep-example/Cargo.toml b/examples/devdep-example/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "simple"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+fltk = "1.3.20"
+
+[build-dependencies]
+fl2rust = { path = "../../fl2rust" }
diff --git a/examples/devdep-example/build.rs b/examples/devdep-example/build.rs
diff --git a/examples/devdep-example/src/main.rs b/examples/devdep-example/src/main.rs
@@ -0,0 +1,9 @@
+use fltk::{prelude::*, *};
+
+mod myuifile;
+
+fn main() {
+    let app = app::App::default();
+    let _ui = myuifile::UserInterface::make_window();
+    app.run().unwrap();
+}
diff --git a/examples/devdep-example/src/myuifile.fl b/examples/devdep-example/src/myuifile.fl
diff --git a/examples/devdep-example/src/myuifile.rs b/examples/devdep-example/src/myuifile.rs
diff --git a/examples/fltkform-example/Cargo.toml b/examples/fltkform-example/Cargo.toml
@@ -11,4 +11,4 @@ fltk-form = "0.1"
 fltk-form-derive = "0.1"
 
 [build-dependencies]
-fl2rust = { path = "../.." }
+fl2rust = { path = "../../fl2rust" }
diff --git a/examples/simple/Cargo.toml b/examples/simple/Cargo.toml
@@ -7,6 +7,4 @@ edition = "2021"
 
 [dependencies]
 fltk = "1.3.20"
-
-[build-dependencies]
-fl2rust = { path = "../.." }
+fl2rust-macro = { path = "../../fl2rust-macro" }
diff --git a/examples/simple/src/main.rs b/examples/simple/src/main.rs
@@ -1,9 +1,12 @@
 use fltk::{prelude::*, *};
 
-mod myuifile;
+mod ui {
+    fl2rust_macro::include_ui!("src/myui.fl");
+}
 
 fn main() {
-    let app = app::App::default();
-    let _ui = myuifile::UserInterface::make_window();
-    app.run().unwrap();
+    let a = app::App::default();
+    let mut ui = ui::UserInterface::make_window();
+    ui.but.set_callback(|b| println!("Button clicked!"));
+    a.run().unwrap();
 }
diff --git a/examples/simple/src/myui.fl b/examples/simple/src/myui.fl
@@ -0,0 +1,18 @@
+# data file for the Fltk User Interface Designer (fluid)
+version 1.0400
+header_name {.h}
+code_name {.cxx}
+class UserInterface {open
+} {
+  Function {make_window()} {open
+  } {
+    Fl_Window {} {open selected
+    xywh {138 161 440 355} type Double visible
+    } {
+      Fl_Button but {
+        label {Click me}
+        xywh {175 230 95 45} color 25
+      }
+    }
+  }
+}
diff --git a/fl2rust-macro/Cargo.toml b/fl2rust-macro/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "fl2rust-macro"
+version = "0.5.5"
+authors = ["Mohammed Alyousef <mohammed.alyousef@neurosrg.com>"]
+edition = "2021"
+description = "A fluid (fltk ui designer) file to Rust transpiler"
+repository = "https://github.com/fltk-rs/fl2rust"
+documentation = "https://docs.rs/fl2rust"
+keywords = ["gui", "ui", "widgets", "bindings", "graphics"]
+categories = ["gui"]
+readme = "README.md"
+license = "MIT"
+rust-version = "1.63"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+fl2rust = { path = "../fl2rust", version = "0.5" }
+fluid-parser = "0.1"
diff --git a/fl2rust-macro/README.md b/fl2rust-macro/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/fl2rust-macro/src/lib.rs b/fl2rust-macro/src/lib.rs
@@ -0,0 +1,27 @@
+#![doc = include_str!("../README.md")]
+
+extern crate proc_macro;
+use proc_macro::TokenStream;
+use fluid_parser::lexer::Lexer;
+use fluid_parser::parser::Parser;
+
+#[proc_macro]
+pub fn include_ui(input: TokenStream) -> TokenStream {
+    let input = input.to_string();
+    let input = std::fs::read_to_string(&input[1..input.len() - 1]).unwrap();
+    let lexer = Lexer::new(&input);
+    let mut parser = Parser::new(lexer);
+    let ast = parser.parse();
+    let out = fl2rust::gen::generate(&ast);
+    out.parse().unwrap()
+}
+
+#[proc_macro]
+pub fn build_ui(input: TokenStream) -> TokenStream {
+    let input = input.to_string();
+    let lexer = Lexer::new(&input);
+    let mut parser = Parser::new(lexer);
+    let ast = parser.parse();
+    let out = fl2rust::gen::generate(&ast);
+    out.parse().unwrap()
+}
diff --git a/fl2rust/Cargo.toml b/fl2rust/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "fl2rust"
-version = "0.5.4"
+version = "0.5.5"
 authors = ["Mohammed Alyousef <mohammed.alyousef@neurosrg.com>"]
 edition = "2021"
 description = "A fluid (fltk ui designer) file to Rust transpiler"
diff --git a/fl2rust/README.md b/fl2rust/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/fl2rust/src/gen.rs b/fl2rust/src/gen.rs
diff --git a/fl2rust/src/lib.rs b/fl2rust/src/lib.rs
@@ -0,0 +1,62 @@
+#![doc = include_str!("../README.md")]
+
+#![allow(clippy::needless_doctest_main)]
+
+pub mod gen;
+mod utils;
+
+use fluid_parser::lexer::Lexer;
+use fluid_parser::parser::Parser;
+use std::error;
+use std::fs;
+use std::path::*;
+
+/// Generator struct
+#[derive(Default)]
+pub struct Generator {}
+
+impl Generator {
+    /// Takes an input and output files
+    pub fn in_out<P: AsRef<Path>>(
+        &self,
+        inpath: P,
+        outpath: P,
+    ) -> Result<(), Box<dyn error::Error>> {
+        let content = fs::read_to_string(inpath)?;
+        let lexer = Lexer::new(&content);
+        let mut parser = Parser::new(lexer);
+        fs::write(outpath, gen::generate(&parser.parse()))?;
+        Ok(())
+    }
+
+    /// Takes an input and output files
+    pub fn in_out_with_directives_preamble<P: AsRef<Path>>(
+        &self,
+        inpath: P,
+        outpath: P,
+    ) -> Result<(), Box<dyn error::Error>> {
+        let content = fs::read_to_string(inpath)?;
+        let lexer = Lexer::new(&content);
+        let mut parser = Parser::new(lexer);
+        fs::write(
+            outpath,
+            gen::generate_with_directives_preamble(&parser.parse()),
+        )?;
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        use super::*;
+        let g = Generator::default();
+        g.in_out("fl_tests/fl.fl", "fl_tests/fl.rs")
+            .expect("Failed to generate rust from fl file!");
+        g.in_out("fl_tests/fl2.fl", "fl_tests/fl2.rs")
+            .expect("Failed to generate rust from fl file!");
+        g.in_out("fl_tests/unt.fl", "fl_tests/unt.rs")
+            .expect("Failed to generate rust from fl file!");
+    }
+}
diff --git a/fl2rust/src/main.rs b/fl2rust/src/main.rs
@@ -0,0 +1,21 @@
+#![doc = include_str!("../README.md")]
+
+#![allow(clippy::needless_doctest_main)]
+
+use fluid_parser::lexer::Lexer;
+use fluid_parser::parser::Parser;
+use std::error;
+use std::fs;
+
+fn main() -> Result<(), Box<dyn error::Error>> {
+    let args: Vec<String> = std::env::args().collect();
+    let f = fs::read_to_string(&args[1])?;
+    let lexer = Lexer::new(&f);
+    let mut parser = Parser::new(lexer);
+    let ast = parser.parse();
+    println!("{}", fl2rust::gen::generate_with_directives_preamble(&ast));
+    if args.contains(&"--print-ast".to_string()) {
+        println!("{:#?}", ast);
+    }
+    Ok(())
+}
diff --git a/fl2rust/src/utils.rs b/fl2rust/src/utils.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/main.rs b/src/main.rs
