1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
#![feature(doc_cfg)]
#![doc(html_logo_url = "https://relm4.org/icons/relm4_logo.svg")]
#![doc(html_favicon_url = "https://relm4.org/icons/relm4_org.svg")]
#![allow(clippy::single_component_path_imports)]
use proc_macro::{self, TokenStream};
use quote::quote;
use syn::parse_macro_input;
mod additional_fields;
mod args;
mod attrs;
mod derive_components;
mod factory_prototype_macro;
mod item_impl;
mod macros;
mod menu;
mod micro_widget_macro;
#[macro_use]
mod util;
mod widget_macro;
mod widgets;
// Hack to make the macro visible for other parts of this crate.
pub(crate) use parse_func;
use attrs::Attrs;
use item_impl::ItemImpl;
use menu::Menus;
use widgets::Widget;
/// Macro that implements [`relm4::Widgets`](https://relm4.org/docs/stable/relm4/trait.Widgets.html) and generates the corresponding struct.
///
/// # Attributes
///
/// To create public struct use `#[widget(pub)]` or `#[widget(visibility = pub)]`.
///
/// If you use reexports to provide relm4, then you can use `#[widget(relm4= ::myreexports::my_relm)]` to override relm4 used during generating struct.
///
/// # Example
///
/// ```
/// use gtk::prelude::{BoxExt, ButtonExt, GtkWindowExt, OrientableExt};
/// use relm4::{gtk, send, AppUpdate, Model, RelmApp, Sender, WidgetPlus, Widgets};
///
/// #[derive(Default)]
/// struct AppModel {
/// counter: u8,
/// }
///
/// enum AppMsg {
/// Increment,
/// Decrement,
/// }
///
/// impl Model for AppModel {
/// type Msg = AppMsg;
/// type Widgets = AppWidgets;
/// type Components = ();
/// }
///
/// impl AppUpdate for AppModel {
/// fn update(&mut self, msg: AppMsg, _components: &(), _sender: Sender<AppMsg>) -> bool {
/// match msg {
/// AppMsg::Increment => {
/// self.counter = self.counter.wrapping_add(1);
/// }
/// AppMsg::Decrement => {
/// self.counter = self.counter.wrapping_sub(1);
/// }
/// }
/// true
/// }
/// }
///
/// #[relm4_macros::widget]
/// impl Widgets<AppModel, ()> for AppWidgets {
/// view! {
/// gtk::ApplicationWindow {
/// set_title: Some("Simple app"),
/// set_default_width: 300,
/// set_default_height: 100,
/// set_child = Some(>k::Box) {
/// set_orientation: gtk::Orientation::Vertical,
/// set_margin_all: 5,
/// set_spacing: 5,
///
/// append = >k::Button {
/// set_label: "Increment",
/// connect_clicked(sender) => move |_| {
/// send!(sender, AppMsg::Increment);
/// },
/// },
/// append = >k::Button {
/// set_label: "Decrement",
/// connect_clicked(sender) => move |_| {
/// send!(sender, AppMsg::Decrement);
/// },
/// },
/// append = >k::Label {
/// set_margin_all: 5,
/// set_label: watch! { &format!("Counter: {}", model.counter) },
/// }
/// },
/// }
/// }
/// }
/// ```
#[proc_macro_attribute]
pub fn widget(attributes: TokenStream, input: TokenStream) -> TokenStream {
let Attrs {
visibility,
relm4_path,
} = parse_macro_input!(attributes as Attrs);
let data = parse_macro_input!(input as ItemImpl);
widget_macro::generate_tokens(visibility, relm4_path, data).into()
}
/// Macro that implements [`relm4::MicrosWidgets`](https://relm4.org/docs/stable/relm4/trait.MicroWidgets.html) and generates the corresponding struct.
///
/// It works very similar to [`macro@widget`].
#[proc_macro_attribute]
pub fn micro_widget(attributes: TokenStream, input: TokenStream) -> TokenStream {
let Attrs {
visibility,
relm4_path,
} = parse_macro_input!(attributes as Attrs);
let data = parse_macro_input!(input as ItemImpl);
micro_widget_macro::generate_tokens(visibility, relm4_path, data).into()
}
/// Macro that implements [`relm4::factory::FactoryPrototype`](https://relm4.org/docs/stable/relm4/factory/trait.FactoryPrototype.html)
/// and generates the corresponding widget struct.
///
/// It works very similar to [`macro@widget`].
#[proc_macro_attribute]
pub fn factory_prototype(attributes: TokenStream, input: TokenStream) -> TokenStream {
let Attrs {
visibility,
relm4_path,
} = parse_macro_input!(attributes as Attrs);
let data = parse_macro_input!(input as ItemImpl);
factory_prototype_macro::generate_tokens(visibility, relm4_path, data).into()
}
#[proc_macro_derive(Components, attributes(components))]
pub fn derive(input: TokenStream) -> TokenStream {
let derive_input = parse_macro_input!(input);
let output = derive_components::generate_stream(&derive_input);
match output {
Ok(output) => output.into(),
Err(error) => error.into_compile_error().into(),
}
}
/// A macro to create menus.
///
/// # Example
///
/// ```
/// // Define some actions
/// relm4::new_action_group!(WindowActionGroup, "win");
/// relm4::new_stateless_action!(TestAction, WindowActionGroup, "test");
/// relm4::new_stateful_action!(TestU8Action, WindowActionGroup, "test2", u8, u8);
///
/// // Create a `MenuModel` called `menu_model`
/// relm4_macros::menu! {
/// main_menu: {
/// "Test" => TestAction,
/// "Test2" => TestAction,
/// "Test toggle" => TestU8Action(1_u8),
/// section! {
/// "Section test" => TestAction,
/// "Test toggle" => TestU8Action(1_u8),
/// },
/// section! {
/// "Test" => TestAction,
/// "Test2" => TestAction,
/// "Test Value" => TestU8Action(1_u8),
/// }
/// }
/// };
/// ```
#[proc_macro]
pub fn menu(input: TokenStream) -> TokenStream {
let menus = parse_macro_input!(input as Menus);
let default_relm4_path = util::default_relm4_path();
menus.menus_stream(&default_relm4_path).into()
}
/// The [`view!`] macro allows you to construct your UI easily and cleanly.
///
/// It does the same as inside the [`macro@widget`] attribute macro,
/// but with less features (no factories, components, etc).
///
/// You can even use the `relm4-macros` crate independently from Relm4 to build your GTK4 UI.
///
/// ```no_run
/// use relm4::gtk;
/// use gtk::prelude::{BoxExt, ButtonExt};
///
/// // Creating a box with a button inside.
/// relm4_macros::view! {
/// vbox = gtk::Box {
/// append = >k::Button {
/// set_label: "Click me!",
/// connect_clicked => |_| {
/// println!("Hello world!");
/// }
/// },
/// }
/// }
///
/// // You can simply use the vbox created in the macro.
/// let spacing = vbox.spacing();
/// ```
///
/// Also, the macro doesn't rely on any special gtk4-rs features
/// so you can even use the macro for other purposes.
///
/// In this example, we use it to construct a [`Command`](std::process::Command).
///
/// ```
/// use std::process::Command;
///
/// let path = "/";
///
/// relm4_macros::view! {
/// mut process = Command::new("ls") {
/// args: ["-la"],
/// current_dir = mut &String {
/// push_str: path,
/// },
/// env: args!("HOME", "/home/relm4"),
/// }
/// }
///
/// // Output of "ls -la" at "/"
/// dbg!(process.output());
/// ```
#[proc_macro]
pub fn view(input: TokenStream) -> TokenStream {
let widgets = parse_macro_input!(input as Widget);
let default_relm4_path = util::default_relm4_path();
let model_type = syn::Type::Tuple(syn::TypeTuple {
paren_token: syn::token::Paren::default(),
elems: syn::punctuated::Punctuated::new(),
});
let mut streams = widget_macro::token_streams::TokenStreams::default();
widgets.generate_widget_tokens_recursively(
&mut streams,
&None,
&model_type,
&default_relm4_path,
);
let widget_macro::token_streams::TokenStreams {
init_widgets,
assign_properties,
connect,
..
} = streams;
let output = quote! {
#init_widgets
#assign_properties
#connect
};
output.into()
}