mirror of
https://github.com/DioxusLabs/dioxus
synced 2024-12-19 00:53:12 +00:00
250 lines
8.2 KiB
Rust
250 lines
8.2 KiB
Rust
use proc_macro::TokenStream;
|
|
use quote::ToTokens;
|
|
use syn::parse_macro_input;
|
|
|
|
pub(crate) mod ifmt;
|
|
pub(crate) mod inlineprops;
|
|
pub(crate) mod props;
|
|
pub(crate) mod router;
|
|
pub(crate) mod rsx;
|
|
|
|
#[proc_macro]
|
|
pub fn format_args_f(input: TokenStream) -> TokenStream {
|
|
use ifmt::*;
|
|
let item = parse_macro_input!(input as IfmtInput);
|
|
format_args_f_impl(item)
|
|
.unwrap_or_else(|err| err.to_compile_error())
|
|
.into()
|
|
}
|
|
|
|
#[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 html! macro makes it easy for developers to write jsx-style markup in their components.
|
|
///
|
|
/// ## Complete Reference Guide:
|
|
/// ```
|
|
/// const Example: Component<()> = |cx, props|{
|
|
/// 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 {
|
|
/// 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 {}))}
|
|
///
|
|
/// // True conditions
|
|
/// {if true {
|
|
/// rsx!(h1 {"Top text"})
|
|
/// } else {
|
|
/// 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
|
|
/// pub fn Baller(cx: Context<()>) -> DomTree {
|
|
/// todo!()
|
|
/// }
|
|
/// }
|
|
///
|
|
/// #[derive(Debug, PartialEq, Props)]
|
|
/// pub struct TallerProps {
|
|
/// a: &'static str,
|
|
/// }
|
|
///
|
|
/// /// This component is taller than most :)
|
|
/// pub fn Taller(cx: Context<TallerProps>) -> DomTree {
|
|
/// let b = true;
|
|
/// todo!()
|
|
/// }
|
|
/// ```
|
|
#[proc_macro]
|
|
pub fn rsx(s: TokenStream) -> TokenStream {
|
|
match syn::parse::<rsx::CallBody>(s) {
|
|
Err(e) => e.to_compile_error().into(),
|
|
Ok(s) => s.to_token_stream().into(),
|
|
}
|
|
}
|
|
|
|
/// Derive macro used to mark an enum as Routable.
|
|
///
|
|
/// This macro can only be used on enums. Every varient of the macro needs to be marked
|
|
/// with the `at` attribute to specify the URL of the route. It generates an implementation of
|
|
/// `yew_router::Routable` trait and `const`s for the routes passed which are used with `Route`
|
|
/// component.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// # use yew_router::Routable;
|
|
/// #[derive(Debug, Clone, Copy, PartialEq, Routable)]
|
|
/// enum Routes {
|
|
/// #[at("/")]
|
|
/// Home,
|
|
/// #[at("/secure")]
|
|
/// Secure,
|
|
/// #[at("/profile/{id}")]
|
|
/// Profile(u32),
|
|
/// #[at("/404")]
|
|
/// NotFound,
|
|
/// }
|
|
/// ```
|
|
#[proc_macro_derive(Routable, attributes(at, not_found))]
|
|
pub fn routable_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
|
use router::{routable_derive_impl, Routable};
|
|
let input = parse_macro_input!(input as Routable);
|
|
routable_derive_impl(input).into()
|
|
}
|
|
|
|
/// 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]
|
|
/// 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(),
|
|
}
|
|
}
|