dioxus/packages/core-macro/src/lib.rs

246 lines
8.1 KiB
Rust
Raw Normal View History

2021-02-28 22:30:10 +00:00
use proc_macro::TokenStream;
2022-05-29 13:04:08 +00:00
use quote::ToTokens;
2021-03-04 17:03:22 +00:00
use syn::parse_macro_input;
2021-01-20 17:04:27 +00:00
2022-02-19 04:14:17 +00:00
mod inlineprops;
mod props;
2022-04-24 06:35:52 +00:00
// mod rsx;
use dioxus_rsx as rsx;
2022-02-19 04:14:17 +00:00
#[proc_macro]
2021-02-28 22:30:10 +00:00
pub fn format_args_f(input: TokenStream) -> TokenStream {
2022-05-25 13:58:59 +00:00
use rsx::*;
let item = parse_macro_input!(input as IfmtInput);
2021-03-08 02:28:20 +00:00
format_args_f_impl(item)
.unwrap_or_else(|err| err.to_compile_error())
.into()
2021-01-20 17:04:27 +00:00
}
2021-12-21 05:46:10 +00:00
#[proc_macro_derive(Props, attributes(props))]
pub fn derive_typed_builder(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
let input = parse_macro_input!(input as syn::DeriveInput);
match props::impl_my_derive(&input) {
Ok(output) => output.into(),
Err(error) => error.to_compile_error().into(),
}
}
/// The rsx! macro makes it easy for developers to write jsx-style markup in their components.
///
/// ## Complete Reference Guide:
/// ```
2021-12-29 04:48:25 +00:00
/// const Example: Component = |cx| {
/// let formatting = "formatting!";
/// let formatting_tuple = ("a", "b");
/// let lazy_fmt = format_args!("lazily formatted text");
/// cx.render(rsx! {
/// div {
/// // Elements
/// div {}
/// h1 {"Some text"}
/// h1 {"Some text with {formatting}"}
/// h1 {"Formatting basic expressions {formatting_tuple.0} and {formatting_tuple.1}"}
/// h2 {
/// "Multiple"
/// "Text"
/// "Blocks"
/// "Use comments as separators in html"
/// }
/// div {
/// h1 {"multiple"}
/// h2 {"nested"}
/// h3 {"elements"}
/// }
/// div {
/// class: "my special div"
/// h1 {"Headers and attributes!"}
/// }
/// div {
/// // pass simple rust expressions in
/// class: lazy_fmt,
/// id: format_args!("attributes can be passed lazily with std::fmt::Arguments"),
/// div {
/// class: {
/// const WORD: &str = "expressions";
/// format_args!("Arguments can be passed in through curly braces for complex {}", WORD)
/// }
/// }
/// }
///
/// // Expressions can be used in element position too:
/// {rsx!(p { "More templating!" })}
/// {html!(<p>"Even HTML templating!!"</p>)}
///
/// // Iterators
/// {(0..10).map(|i| rsx!(li { "{i}" }))}
/// {{
/// let data = std::collections::HashMap::<&'static str, &'static str>::new();
/// // Iterators *should* have keys when you can provide them.
/// // Keys make your app run faster. Make sure your keys are stable, unique, and predictable.
/// // Using an "ID" associated with your data is a good idea.
/// data.into_iter().map(|(k, v)| rsx!(li { key: "{k}" "{v}" }))
/// }}
///
/// // Matching
/// {match true {
2021-11-03 04:35:56 +00:00
/// true => rsx!(h1 {"Top text"}),
/// false => rsx!(h1 {"Bottom text"})
/// }}
///
/// // Conditional rendering
/// // Dioxus conditional rendering is based around None/Some. We have no special syntax for conditionals.
/// // You can convert a bool condition to rsx! with .then and .or
/// {true.then(|| rsx!(div {}))}
///
2021-11-03 04:35:56 +00:00
/// // True conditions
/// {if true {
2021-11-03 04:35:56 +00:00
/// rsx!(h1 {"Top text"})
/// } else {
2021-11-03 04:35:56 +00:00
/// rsx!(h1 {"Bottom text"})
/// }}
///
/// // returning "None" is a bit noisy... but rare in practice
/// {None as Option<()>}
///
/// // Use the Dioxus type-alias for less noise
/// {NONE_ELEMENT}
///
/// // can also just use empty fragments
/// Fragment {}
///
/// // Fragments let you insert groups of nodes without a parent.
/// // This lets you make components that insert elements as siblings without a container.
/// div {"A"}
/// Fragment {
/// div {"B"}
/// div {"C"}
/// Fragment {
/// "D"
/// Fragment {
/// "heavily nested fragments is an antipattern"
/// "they cause Dioxus to do unnecessary work"
/// "don't use them carelessly if you can help it"
/// }
/// }
/// }
///
/// // Components
/// // Can accept any paths
/// // Notice how you still get syntax highlighting and IDE support :)
/// Baller {}
/// baller::Baller { }
/// crate::baller::Baller {}
///
/// // Can take properties
/// Taller { a: "asd" }
///
/// // Can take optional properties
/// Taller { a: "asd" }
///
/// // Can pass in props directly as an expression
/// {{
/// let props = TallerProps {a: "hello"};
/// rsx!(Taller { ..props })
/// }}
///
/// // Spreading can also be overridden manually
/// Taller {
/// ..TallerProps { a: "ballin!" }
/// a: "not ballin!"
/// }
///
/// // Can take children too!
/// Taller { a: "asd", div {"hello world!"} }
/// }
/// })
/// };
///
/// mod baller {
/// use super::*;
/// pub struct BallerProps {}
///
/// /// This component totally balls
2021-12-30 02:28:28 +00:00
/// pub fn Baller(cx: Scope) -> DomTree {
/// todo!()
/// }
/// }
///
/// #[derive(Debug, PartialEq, Props)]
/// pub struct TallerProps {
/// a: &'static str,
/// }
///
/// /// This component is taller than most :)
2021-12-29 04:48:25 +00:00
/// pub fn Taller(cx: Scope<TallerProps>) -> DomTree {
/// let b = true;
/// todo!()
/// }
/// ```
#[proc_macro]
pub fn rsx(s: TokenStream) -> TokenStream {
#[cfg(feature = "hot_reload")]
let rsx_text = s.to_string();
2022-02-22 21:34:06 +00:00
match syn::parse::<rsx::CallBody>(s) {
Err(err) => err.to_compile_error().into(),
2022-05-25 13:58:59 +00:00
Ok(body) => {
#[cfg(feature = "hot_reload")]
{
2022-06-02 18:33:08 +00:00
use dioxus_rsx_interpreter::captuered_context::CapturedContextBuilder;
2022-05-25 13:58:59 +00:00
2022-05-30 23:32:57 +00:00
match CapturedContextBuilder::from_call_body(body) {
Ok(captured) => quote::quote! {
{
2022-06-04 19:26:37 +00:00
LazyNodes::new(move |__cx|{
let captured = #captured;
let line_num = get_line_num();
let text = #rsx_text;
resolve_scope(line_num, text, captured, __cx)
})
2022-05-30 23:32:57 +00:00
}
2022-05-25 16:20:07 +00:00
}
.into(),
2022-05-30 23:32:57 +00:00
Err(err) => err.into_compile_error().into(),
2022-05-25 16:20:07 +00:00
}
2022-05-25 13:58:59 +00:00
}
#[cfg(not(feature = "hot_reload"))]
body.to_token_stream().into()
}
}
}
2021-11-03 04:35:56 +00:00
/// Derive props for a component within the component definition.
///
/// This macro provides a simple transformation from `Scope<{}>` to `Scope<P>`,
/// removing some boilerplate when defining props.
///
/// You don't *need* to use this macro at all, but it can be helpful in cases where
/// you would be repeating a lot of the usual Rust boilerplate.
///
/// # Example
/// ```
/// #[inline_props]
2021-12-29 04:20:01 +00:00
/// fn app(cx: Scope, bob: String) -> Element {
/// cx.render(rsx!("hello, {bob}"))
/// }
///
/// // is equivalent to
///
/// #[derive(PartialEq, Props)]
/// struct AppProps {
/// bob: String,
/// }
///
/// fn app(cx: Scope<AppProps>) -> Element {
/// cx.render(rsx!("hello, {bob}"))
/// }
/// ```
#[proc_macro_attribute]
pub fn inline_props(_args: proc_macro::TokenStream, s: TokenStream) -> TokenStream {
match syn::parse::<inlineprops::InlinePropsBody>(s) {
Err(e) => e.to_compile_error().into(),
Ok(s) => s.to_token_stream().into(),
}
}