Proof of concept, argument to export_to other than &'static str
#347
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,244 @@ | ||
| use quote::{format_ident, quote}; | ||
| use proc_macro2::TokenStream; | ||
| use syn::{ | ||
| parse::{Parse, ParseStream}, | ||
| Error, Lit, Ident,LitStr, Token, Result, | ||
| }; | ||
|
|
||
|
|
||
| #[derive(Clone,Debug)] | ||
| pub enum CustomPath{ | ||
| Str(String), | ||
| Static(syn::Path), | ||
| Fn(syn::Path), | ||
| Env(syn::LitStr), | ||
| } | ||
|
|
||
| type FnOutputPathBody = ( TokenStream, Option<TokenStream> ); | ||
|
|
||
| impl CustomPath { | ||
|
|
||
| pub fn get_path_and_some_decl(&self, ts_name: &String ) -> FnOutputPathBody { | ||
|
|
||
| match self { | ||
|
|
||
| Self::Str(input) => { Self::str_path(input,ts_name) }, | ||
|
|
||
| Self::Static(input) => { Self::static_path(input,ts_name) }, | ||
|
|
||
| Self::Fn(input) => { Self::fn_path(input,ts_name) }, | ||
|
|
||
| Self::Env(input) => { Self::env_path(input,ts_name) }, | ||
|
|
||
| } | ||
| } | ||
|
|
||
| fn str_path( input: &String, ts_name: &String ) -> FnOutputPathBody { | ||
|
|
||
| let path = | ||
| if input.ends_with('/') { | ||
| format!("{}{}.ts", input, ts_name) | ||
| } else { | ||
| input.to_owned() | ||
| }; | ||
|
|
||
| return (quote!(#path),None); | ||
| } | ||
|
|
||
| fn static_path( input: &syn::Path, ts_name: &String ) -> FnOutputPathBody { | ||
|
|
||
| let path_ident = format_ident!("path"); | ||
| let stat_path_ident = format_ident!("PATH"); | ||
| let path_decl = quote! { | ||
|
|
||
| static #stat_path_ident: std::sync::OnceLock<String> = std::sync::OnceLock::new(); | ||
|
|
||
| let #path_ident = #stat_path_ident.get_or_init( || | ||
| { | ||
| if #input.ends_with('/') { | ||
| format!("{}{}.ts", #input, #ts_name) | ||
| } else { | ||
| format!("{}",#input) | ||
| } | ||
| } | ||
| ); | ||
| }; | ||
|
|
||
| ( quote!(#path_ident), Some(path_decl) ) | ||
| } | ||
|
|
||
| fn fn_path( input: &syn::Path, ts_name: &String ) -> FnOutputPathBody { | ||
|
|
||
| ( quote!{#input (#ts_name)?}, None) | ||
| } | ||
|
|
||
| fn env_path( input: &LitStr, ts_name: &String ) -> FnOutputPathBody { | ||
|
|
||
| let path_ident = format_ident!("path"); | ||
|
|
||
| let path_decl = quote!{ | ||
|
|
||
| let #path_ident = if std::env!(#input).ends_with('/') { | ||
| std::concat!(std::env!(#input),#ts_name,".ts") | ||
| } else { | ||
| std::env!(#input) | ||
| }; | ||
| }; | ||
|
|
||
| ( quote!(#path_ident), Some(path_decl) ) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| impl Parse for CustomPath { | ||
|
|
||
| fn parse(input: ParseStream) -> Result<CustomPath> { | ||
| input.parse::<Token![=]>()?; | ||
| let span = input.span(); | ||
|
|
||
| let msg = | ||
| "expected arguments for 'export_to': | ||
|
|
||
| 1) string literal | ||
| #[ts(export_to = \"my/path\")] | ||
|
|
||
| 2) static or constant variable name | ||
|
|
||
| #[ts(export_to = MY_STATIC_PATH)] | ||
| #[ts(export_to = crate::MY_STATIC_PATH)] | ||
|
|
||
| Note: This option is available for Rust 1.7.0 and higher! | ||
|
There was a problem hiding this comment. This feels like a typo, did you really mean 1.7.0? The MSRV for There was a problem hiding this comment. It's not a typo std::sync::OnceLock is stabilised in Rust 1.70.0, probably available 1.63. nightly only. The idiomatic way is to check the Rust version, but #[cfg(version(..))]) isn't stabilised as well. The worst-case scenario is a compile-time error, informing the user that Additionally, since not sure what to do with it it's up to you really. There was a problem hiding this comment. So you meant 1.70.0 right? There was a problem hiding this comment. And the code says 1.7... you're missing a zero There was a problem hiding this comment. That's right, it is a typo ))) There was a problem hiding this comment. Alright, in that case, we can just change the MSRV to 1.70.0 and we don't have to worry about it |
||
|
|
||
| 3) function name of a `Fn(&'static str) -> Option<&'static str>` | ||
|
|
||
| #[ts(export_to = get_path)] | ||
| #[ts(export_to = crate::get_path)] | ||
|
|
||
| Note: This option overrides the original `TS::output_path` logic`! | ||
|
There was a problem hiding this comment. I'm not really sure if we should allow users to override There was a problem hiding this comment. things that may go wrong with this option:
Also I've found a way to propagate the error the correct message fn output_path() -> Option<&'static std::path::Path> {
let path: fn(&'static str) -> Option<&'static str> = crate::get_path_fn;
Some(std::path::Path::new(path("ObjC")?))
} it is precise! |
||
|
|
||
| 4) environment variable name | ||
|
|
||
| #[ts(export_to = env(\"MY_ENV_VAR_PATH\"))] | ||
|
|
||
| Note: This option is for environment variables defined in the '.cargo/config.toml' file only, accessible through the `env!` macro! | ||
| "; | ||
|
There was a problem hiding this comment. This message should be a module level |
||
| let get_path = |input: ParseStream| -> Result<(syn::Path,Option<LitStr>)>{ | ||
| let mut tokens = TokenStream::new(); | ||
| let mut env_var_str = None; | ||
|
|
||
| if input.peek(Token![self]) { | ||
| let token = input.parse::<Token![self]>()?; | ||
| tokens.extend(quote!(#token)); | ||
| } | ||
| if input.peek(Token![super]) { | ||
| let token = input.parse::<Token![super]>()?; | ||
| tokens.extend(quote!(#token)); | ||
| } | ||
| if input.peek(Token![crate]) { | ||
| let token = input.parse::<Token![crate]>()?; | ||
| tokens.extend(quote!(#token)); | ||
| } | ||
| if input.peek(Ident) { | ||
| let ident = input.parse::<Ident>()?; | ||
| tokens.extend(quote!(#ident)); | ||
| } | ||
|
|
||
| while input.peek(Token![::]) { | ||
| let token = input.parse::<Token![::]>()?; | ||
| tokens.extend(quote!(#token)); | ||
|
|
||
| if input.peek(Ident){ | ||
| let ident = input.parse::<Ident>()?; | ||
| tokens.extend(quote!(#ident)); | ||
| } else { return Err(Error::new(input.span(),"expected ident")) } | ||
| } | ||
|
|
||
| if input.peek(syn::token::Paren){ | ||
| let content; | ||
| syn::parenthesized!(content in input); | ||
| env_var_str = Some(content.parse::<LitStr>()?); | ||
| } | ||
|
|
||
| Ok((syn::parse2::<syn::Path>(tokens)?,env_var_str)) | ||
| }; | ||
|
|
||
|
|
||
| // string literal | ||
| if input.peek(LitStr){ | ||
| if let Ok(lit) = Lit::parse(input){ | ||
| match lit { | ||
| Lit::Str(string) => { return Ok(CustomPath::Str(string.value())); }, | ||
| _ => { return Err(Error::new(span, msg)); }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| match get_path(input) { | ||
|
|
||
| Ok((path,arg)) => { | ||
|
|
||
| if !path.segments.is_empty(){ | ||
|
|
||
| if let Some( env_var_str ) = arg { | ||
|
|
||
| if path.is_ident("env") { | ||
| return Ok(CustomPath::Env(env_var_str)); | ||
| } | ||
|
|
||
| } else { | ||
|
|
||
| let last = &path.segments.last().unwrap().ident; | ||
|
|
||
| // static or const | ||
| if is_screaming_snake_case(&last.to_string()) { | ||
| return Ok(CustomPath::Static(path)); | ||
| } | ||
|
|
||
| // function | ||
| if is_snake_case(&last.to_string()) { | ||
| return Ok(CustomPath::Fn(path)); | ||
| } | ||
|
There was a problem hiding this comment. Another reason I don't really like allowing a function path here is that there is no reliable way to differentiate between a function name and a const/static name. Sure, clippy will complain if a const isn't in SCREAMING_SNAKE_CASE, but it doesn't prevent the code from compiling There was a problem hiding this comment. I've triyed this scenario on the new design (I've mentioned above, assignment to a function pointer ) and it looks like so for lower case static the error will be : |
||
| } | ||
| } | ||
| return Err(Error::new(span, msg)); | ||
| }, | ||
|
|
||
| Err(e) => return Err(Error::new(e.span(), msg)), | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // These functions mimic Rust's naming conventions for | ||
| // statics, constants, and function . | ||
| // To be replaced with proper, more robust validation. | ||
|
|
||
| fn is_screaming_snake_case(s: &str) -> bool { | ||
|
|
||
| if s.is_empty() || s.starts_with('_') || s.ends_with('_') || s.contains("__") { | ||
| return false; | ||
| } | ||
|
|
||
| for c in s.chars() { | ||
| if !c.is_ascii_uppercase() && c != '_' { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| true | ||
| } | ||
|
|
||
| fn is_snake_case(s: &str) -> bool { | ||
|
|
||
| if s.is_empty() || s.starts_with('_') { | ||
| return false; | ||
| } | ||
|
|
||
| for c in s.chars() { | ||
| if !c.is_ascii_lowercase() && c != '_' { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| true | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Formatting feels weird, can you run
cargo +nightly fmt?