Macro for parsing KCL at Rust compile-time (#1049)

Macro for parsing KCL at Rust compile-time

This adds a new `parse_kcl!` macro which takes a string as input. It parses the string into KCL source code _at compile-time_. Invalid KCL will make your Rust project fail to compile.

Fixes https://github.com/KittyCAD/modeling-app/issues/1018

src/wasm-lib/Cargo.lock

@@ -1463,6 +1463,18 @@ dependencies = [
  "winnow",
 ]
 
+[[package]]
+name = "kcl-macros"
+version = "0.1.0"
+dependencies = [
+ "databake",
+ "kcl-lib",
+ "pretty_assertions",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.39",
+]
+
 [[package]]
 name = "kittycad"
 version = "0.2.41"

src/wasm-lib/Cargo.toml

@@ -53,6 +53,7 @@ debug = true
 members = [
 	"derive-docs",
 	"kcl",
+  "kcl-macros",
 ]
 
 [workspace.dependencies]

src/wasm-lib/kcl-macros/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "kcl-macros"
+description = "Macro for compiling KCL to its AST during Rust compile-time"
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/KittyCAD/modeling-app"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+proc-macro = true
+
+[dependencies]
+databake = "0.1.6"
+kcl-lib = { path = "../kcl" }
+proc-macro2 = "1"
+quote = "1"
+syn = { version = "2.0.39", features = ["full"] }
+
+[dev-dependencies]
+pretty_assertions = "1.4.0"

src/wasm-lib/kcl-macros/src/lib.rs

@@ -0,0 +1,22 @@
+use databake::*;
+use proc_macro::TokenStream;
+use quote::quote;
+use syn::{parse_macro_input, LitStr};
+
+/// Parses KCL into its AST at compile-time.
+/// This macro takes exactly one argument: A string literal containing KCL.
+/// # Examples
+/// ```
+/// extern crate alloc;
+/// use kcl_compile_macro::parse_kcl;
+/// let ast: kcl_lib::ast::types::Program = parse_kcl!("const y = 4");
+/// ```
+#[proc_macro]
+pub fn parse(input: TokenStream) -> TokenStream {
+    let input = parse_macro_input!(input as LitStr);
+    let kcl_src = input.value();
+    let tokens = kcl_lib::token::lexer(&kcl_src);
+    let ast = kcl_lib::parser::Parser::new(tokens).ast().unwrap();
+    let ast_struct = ast.bake(&Default::default());
+    quote!(#ast_struct).into()
+}

src/wasm-lib/kcl-macros/tests/macro_test.rs

@@ -0,0 +1,38 @@
+extern crate alloc;
+use kcl_lib::ast::types::{
+    BodyItem, Identifier, Literal, LiteralValue, NonCodeMeta, Program, Value, VariableDeclaration, VariableDeclarator,
+    VariableKind,
+};
+use kcl_macros::parse;
+use pretty_assertions::assert_eq;
+
+#[test]
+fn basic() {
+    let actual = parse!("const y = 4");
+    let expected = Program {
+        start: 0,
+        end: 11,
+        body: vec![BodyItem::VariableDeclaration(VariableDeclaration {
+            start: 0,
+            end: 11,
+            declarations: vec![VariableDeclarator {
+                start: 6,
+                end: 11,
+                id: Identifier {
+                    start: 6,
+                    end: 7,
+                    name: "y".to_owned(),
+                },
+                init: Value::Literal(Box::new(Literal {
+                    start: 10,
+                    end: 11,
+                    value: LiteralValue::IInteger(4),
+                    raw: "4".to_owned(),
+                })),
+            }],
+            kind: VariableKind::Const,
+        })],
+        non_code_meta: NonCodeMeta::default(),
+    };
+    assert_eq!(expected, actual);
+}

src/wasm-lib/kcl/src/ast/types.rs

@@ -22,7 +22,7 @@ use crate::{
 mod literal_value;
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "camelCase")]
 pub struct Program {
@@ -352,7 +352,7 @@ macro_rules! impl_value_meta {
 pub(crate) use impl_value_meta;
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub enum BodyItem {
@@ -392,7 +392,7 @@ impl From<&BodyItem> for SourceRange {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub enum Value {
@@ -556,7 +556,7 @@ impl From<&Value> for SourceRange {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub enum BinaryPart {
@@ -713,7 +713,7 @@ impl BinaryPart {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct NonCodeNode {
@@ -762,7 +762,7 @@ impl NonCodeNode {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "camelCase")]
 pub enum CommentStyle {
@@ -773,7 +773,7 @@ pub enum CommentStyle {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type", rename_all = "camelCase")]
 pub enum NonCodeValue {
@@ -820,11 +820,11 @@ pub struct NonCodeMeta {
 
 impl Bake for NonCodeMeta {
     fn bake(&self, env: &CrateEnv) -> TokenStream {
-        env.insert("kcl_lib");
+        env.insert("kcl_lib::ast::types");
         let start = self.start.bake(env);
         databake::quote! {
-            kcl_lib::NonCodeMeta {
-                non_code_nodes: HashMap::new(),
+            kcl_lib::ast::types::NonCodeMeta {
+                non_code_nodes: std::collections::HashMap::new(),
                 start: #start,
             }
         }
@@ -865,7 +865,7 @@ impl NonCodeMeta {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct ExpressionStatement {
@@ -877,7 +877,7 @@ pub struct ExpressionStatement {
 impl_value_meta!(ExpressionStatement);
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct CallExpression {
@@ -1146,7 +1146,7 @@ impl PartialEq for Function {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct VariableDeclaration {
@@ -1297,7 +1297,7 @@ impl VariableDeclaration {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, FromStr, Display, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "snake_case")]
 #[display(style = "snake_case")]
@@ -1342,7 +1342,7 @@ impl VariableKind {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct VariableDeclarator {
@@ -1372,7 +1372,7 @@ impl VariableDeclarator {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct Literal {
@@ -1443,7 +1443,7 @@ impl From<&Box<Literal>> for MemoryItem {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct Identifier {
@@ -1480,7 +1480,7 @@ impl Identifier {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct PipeSubstitution {
@@ -1509,7 +1509,7 @@ impl From<PipeSubstitution> for Value {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct ArrayExpression {
@@ -1670,7 +1670,7 @@ impl ArrayExpression {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct ObjectExpression {
@@ -1828,7 +1828,7 @@ impl ObjectExpression {
 impl_value_meta!(ObjectExpression);
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct ObjectProperty {
@@ -1871,7 +1871,7 @@ impl ObjectProperty {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub enum MemberObject {
@@ -1918,7 +1918,7 @@ impl From<&MemberObject> for SourceRange {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub enum LiteralIdentifier {
@@ -1955,7 +1955,7 @@ impl From<&LiteralIdentifier> for SourceRange {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct MemberExpression {
@@ -2119,7 +2119,7 @@ pub struct ObjectKeyInfo {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct BinaryExpression {
@@ -2299,7 +2299,7 @@ pub fn parse_json_value_as_string(j: &serde_json::Value) -> Option<String> {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, FromStr, Display, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "snake_case")]
 #[display(style = "snake_case")]
@@ -2368,7 +2368,7 @@ impl BinaryOperator {
     }
 }
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct UnaryExpression {
@@ -2447,7 +2447,7 @@ impl UnaryExpression {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, FromStr, Display, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "snake_case")]
 #[display(style = "snake_case")]
@@ -2463,7 +2463,7 @@ pub enum UnaryOperator {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(rename_all = "camelCase", tag = "type")]
 pub struct PipeExpression {
@@ -2622,7 +2622,7 @@ async fn execute_pipe_body(
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct FunctionExpression {
@@ -2673,7 +2673,7 @@ impl FunctionExpression {
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(tag = "type")]
 pub struct ReturnStatement {

src/wasm-lib/kcl/src/ast/types/literal_value.rs

@@ -6,7 +6,7 @@ use serde_json::Value as JValue;
 use super::{Literal, Value};
 
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema, Bake)]
-#[databake(path = kcl_lib)]
+#[databake(path = kcl_lib::ast::types)]
 #[ts(export)]
 #[serde(untagged, rename_all = "snake_case")]
 pub enum LiteralValue {