8f1ff189cc
This PR formalizes design components with the Component and ComponentPreview traits. You can open the preview UI with `workspace: open component preview`. Component previews no longer need to return `Self` allowing for more complex previews, and previews of components like `ui::Tooltip` that supplement other components rather than are rendered by default. `cargo-machete` incorrectly identifies `linkme` as an unused dep on crates that have components deriving `IntoComponent`, so you may need to add this to that crate's `Cargo.toml`: ```toml # cargo-machete doesn't understand that linkme is used in the component macro [package.metadata.cargo-machete] ignored = ["linkme"] ``` Release Notes: - N/A --------- Co-authored-by: Marshall Bowers <git@maxdeviant.com>
85 lines
2.8 KiB
Rust
85 lines
2.8 KiB
Rust
mod derive_component;
|
|
mod derive_path_str;
|
|
mod dynamic_spacing;
|
|
|
|
use proc_macro::TokenStream;
|
|
|
|
/// Derives the `path` method for an enum.
|
|
///
|
|
/// This macro generates a `path` method for each variant of the enum, which returns a string
|
|
/// representation of the enum variant's path. The path is constructed using a prefix and
|
|
/// optionally a suffix, which are specified using attributes.
|
|
///
|
|
/// # Attributes
|
|
///
|
|
/// - `#[path_str(prefix = "...")]`: Required. Specifies the prefix for all paths.
|
|
/// - `#[path_str(suffix = "...")]`: Optional. Specifies a suffix for all paths.
|
|
/// - `#[strum(serialize_all = "...")]`: Optional. Specifies the case conversion for variant names.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// use strum::EnumString;
|
|
/// use ui_macros::{path_str, DerivePathStr};
|
|
///
|
|
/// #[derive(EnumString, DerivePathStr)]
|
|
/// #[path_str(prefix = "my_prefix", suffix = ".txt")]
|
|
/// #[strum(serialize_all = "snake_case")]
|
|
/// enum MyEnum {
|
|
/// VariantOne,
|
|
/// VariantTwo,
|
|
/// }
|
|
///
|
|
/// // These assertions would work if we could instantiate the enum
|
|
/// // assert_eq!(MyEnum::VariantOne.path(), "my_prefix/variant_one.txt");
|
|
/// // assert_eq!(MyEnum::VariantTwo.path(), "my_prefix/variant_two.txt");
|
|
/// ```
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// This macro will panic if used on anything other than an enum.
|
|
#[proc_macro_derive(DerivePathStr, attributes(path_str))]
|
|
pub fn derive_path_str(input: TokenStream) -> TokenStream {
|
|
derive_path_str::derive_path_str(input)
|
|
}
|
|
|
|
/// A marker attribute for use with `DerivePathStr`.
|
|
///
|
|
/// This attribute is used to specify the prefix and suffix for the `path` method
|
|
/// generated by `DerivePathStr`. It doesn't modify the input and is only used as a
|
|
/// marker for the derive macro.
|
|
#[proc_macro_attribute]
|
|
pub fn path_str(_args: TokenStream, input: TokenStream) -> TokenStream {
|
|
// This attribute doesn't modify the input, it's just a marker
|
|
input
|
|
}
|
|
|
|
/// Generates the DynamicSpacing enum used for density-aware spacing in the UI.
|
|
#[proc_macro]
|
|
pub fn derive_dynamic_spacing(input: TokenStream) -> TokenStream {
|
|
dynamic_spacing::derive_spacing(input)
|
|
}
|
|
|
|
/// Derives the `Component` trait for a struct.
|
|
///
|
|
/// This macro generates implementations for the `Component` trait and associated
|
|
/// registration functions for the component system.
|
|
///
|
|
/// # Attributes
|
|
///
|
|
/// - `#[component(scope = "...")]`: Required. Specifies the scope of the component.
|
|
/// - `#[component(description = "...")]`: Optional. Provides a description for the component.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// use ui_macros::Component;
|
|
///
|
|
/// #[derive(Component)]
|
|
/// #[component(scope = "toggle", description = "A element that can be toggled on and off")]
|
|
/// struct Checkbox;
|
|
/// ```
|
|
#[proc_macro_derive(IntoComponent, attributes(component))]
|
|
pub fn derive_component(input: TokenStream) -> TokenStream {
|
|
derive_component::derive_into_component(input)
|
|
}
|