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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
/* This file is a part of term-string. Copyright (C) 2018 Mohammad AlSaleh <CE.Mohammad.AlSaleh at gmail.com> https://github.com/rust-alt/term-string This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */ // TODO: README // TODO: Change git repo to version if we publish //! A procedural macro that generates chaining methods from non-chaining ones in an impl block. //! //! //! When applied to an impl block, `#[fluent_impl]` will scan all methods in the block //! in search for chain-able methods, and generate chaining methods //! from them. //! //! Chain-able methods are the ones with `&mut self` as a first argument, and return nothing. //! That's it, there are no other restrictions. //! //! # Usage //! Add `fluent-impl` to the dependencies in `Cargo.toml`: //! //! ``` toml //! [dependencies] //! fluent-impl = "0.1" //! ``` //! //! Then add the following to the top of `src/lib.rs`: //! //! ``` rust ignore //! // Will be stabilized soon //! #![feature(use_extern_macros)] //! //! extern crate fluent_impl; //! //! use fluent_impl::{fluent_impl, fluent_impl_opts}; //! //! ``` //! //! # Examples //! //! If we have a simple struct with a simple impl block: //! //! ``` rust //! #[derive(Default, PartialEq, Debug)] //! pub struct Simple { //! num: i32, //! } //! //! impl Simple { //! // ... //! pub fn add_1(&mut self) { //! self.num +=1; //! } //! } //! ``` //! //! Then we add the macro attribute to the impl block: //! //! ``` rust ignore //! # #![feature(use_extern_macros)] //! # extern crate fluent_impl; //! # use fluent_impl::{fluent_impl, fluent_impl_opts}; //! # struct Simple; //! #[fluent_impl] //! impl Simple { //! // ... //! pub fn add_1(&mut self) { //! self.num +=1; //! } //! } //! ``` //! //! The macro will generate a new impl block with the content: //! //! ``` rust ignore //! #[doc = "Chaining (fluent) methods for [`Simple`]."] //! impl Simple { //! #[doc = "The chaining (fluent) equivalent of [`add_1()`].\n\n [`add_1`]: Simple::add_1\n [`add_1()`]: Simple::add_1"] //! pub fn with_add_1(mut self) -> Self { //! self.add_1(); //! self //! } //! } //! ``` //! //! A full more involved example can be found bellow the *Attribute Configuration* section. //! //! # Attribute Configuration //! //! `#[fluent_impl]` is configurable with comma-separated options passed to the attribute //! itself, and options passed to a method-level attribute `#[fluent_impl_opts]`. //! //! ## `#[fluent_impl]` Attribute Options //! *(`inblock`, `non_public`, `prefix`, `impl_doc`, `doc`)* //! //! *impl block*-level configuration. //! //! ### Example //! //! ``` rust ignore //! #[fluent_impl(inblock, non_public, prefix="chain_")] //! impl Simple { //! // ... //! } //! ``` //! //! ### Options //! //! * **`inblock`** (default: unset) //! //! By default, a new impl block is generated, and chaining methods are added there. //! If `inblock` is passed, every chaining method will be generated right below //! the chain-able one. //! //! The order in which methods appear on docs is probably the only reason why you //! should care about this. //! //! There is a corresponding method-level *`inblock`* option which will selectively enable //! this behavior for individual methods. //! //! * **`non_public`** (default: unset) //! //! By default, non fully-public methods are skipped. If this option is passed, the macro //! will generate chaining equivalents for chain-able private or partially-public methods. //! //! There is a corresponding method-level *`non_public`* option which will selectively enable //! this behavior for individual methods. //! //! * **`prefix`** (default: "with_") //! //! The default chaining method name is this prefix appended by the chain-able method name. //! //! * *`prefix`* is not allowed to be an empty string. Check the *`name`* method-level option //! if you want to name a chaining method to whatever you like. //! //! There is a corresponding method-level *`prefix`* option which will selectively override //! the value set here (or the default). //! //! * **`impl_doc`** (default: "Chaining (fluent) methods for [\`%t%\`].") //! //! If a new block is generated for the chaining methods, this is the doc string template //! for it. `%t%` is is replaced with the type path. //! //! * **`doc`** (default: "The chaining (fluent) equivalent of [\`%f%()\`].") //! //! Chaining method doc string template. `%t%` is is replaced with the type path. `%f%` is //! replaced with the chain-able method name. //! //! Additionally, the following is effectively appended at the end: //! ``` text //! /// //! /// [`%f%`]: %t%::%f% //! /// [`%f%()`]: %t%::%f% //! ``` //! //! This allows proper hyper-linking of ``[`%t%`]`` and ``[`%t%()`]``. //! //! There is a corresponding method-level *`doc`* option which will selectively override //! the value set here (or the default). //! //! ## `#[fluent_impl_opts]` Attribute Options //! *(`inblock`, `non_public`, `skip`, `prefix`, `rename`, `name`, `doc`)* //! //! Options passed to override block-level defaults, or set method-specific //! configurations. //! //! Unlike `#[fluent_impl]`, this attribute: //! 1. Applies to methods instead of impl blocks. //! 2. Can be passed multiple times to the same method if you please. //! //! ### Example //! //! ``` rust ignore //! #[fluent_impl] //! impl Simple { //! #[fluent_impl_opts(non_public, inblock)] //! #[fluent_impl_opts(prefix="chain_", rename="added_1")] //! fn add_1(&mut self) { //! // ... //! } //! } //! ``` //! //! ### Options //! //! #### Inherited //! //! * **`inblock`** (default: inherit) //! //! Set *`inblock`* for this specific method if it's not set for the block already. //! //! * **`non_public`** (default: inherit) //! //! Set *`non_public`* for this specific method if it's not set for the block already. //! //! This allows generating chaining methods for specific private methods, or //! partially public ones (e.g. `pub(crate)` methods). //! //! * **`prefix`** (default: inherit) //! //! Override the default, or the block value if set. //! //! * *`prefix`* is not allowed to be an empty string. //! * Method-specific *`prefix`* is not allowed to be set if *`name`*(see below) is set. //! //! * **`doc`** (default: inherit) //! //! Override the default, or the block value if set. //! //! #### Method Specific //! //! * **`skip`** (default: unset) //! //! Skip this method. Don't generate anything from it. //! //! * **`rename`** (default: chain-able name) //! //! The default chaining method name is the prefix appended by the chain-able method //! name. This option allows you to rename the name that gets added to the prefix. //! //! * *`rename`* is not allowed to be an empty string. //! * *`rename`* is not allowed to be set if *`name`*(see below) is set and vise versa. //! //! * **`name`** (default: unset) //! //! Set the name of the chaining method. //! //! * *`name`* is not allowed to be set if method-specific *`prefix`* or rename is set. //! //! //! # Full Example //! //! ``` rust //! #![feature(use_extern_macros)] //! //! extern crate fluent_impl; //! //! pub mod m { //! use fluent_impl::{fluent_impl, fluent_impl_opts}; //! use std::borrow::Borrow; //! use std::ops::AddAssign; //! //! #[derive(PartialEq, Debug)] //! pub struct TCounter(pub u32); //! //! #[derive(PartialEq, Debug)] //! pub struct St<A: AddAssign> { //! value: A, //! text: String, //! } //! //! #[fluent_impl] //! // impl block with generic arguments works //! impl<A: AddAssign> St<A> { //! // Constants (or any other items) in impl block are okay //! pub(crate) const C_TC: u32 = 100; //! //! pub fn new(value: A, text: String) -> Self { //! Self { value, text } //! } //! //! pub fn get_value(&self) -> &A { //! &self.value //! } //! //! pub fn get_text(&self) -> &str { //! &self.text //! } //! //! #[fluent_impl_opts(rename = "added_value")] //! // Destructuring patterns in method arguments are okay //! pub fn add_value( //! &mut self, //! to_be_added: A, //! TCounter(counter): &mut TCounter, //! ) { //! self.value += to_be_added; //! *counter += 1; //! } //! //! #[fluent_impl_opts(rename = "appended_text")] //! // Generic method arguments are okay //! pub fn append_text<S: Borrow<str>>(&mut self, arg: S) { //! self.text += arg.borrow(); //! } //! //! #[fluent_impl_opts(rename = "appended_text_impl_trait")] //! // Needless to say, impl Trait method arguments are also okay //! pub fn append_text_impl_trait(&mut self, arg: impl Borrow<str>) { //! self.text += arg.borrow(); //! } //! } //! } //! //! fn main() { //! use m::{St, TCounter}; //! // ======== //! let mut tc1 = TCounter(St::<u32>::C_TC); //! let mut s1 = St::new(0u32, "".into()); //! s1.append_text("simple "); //! s1.append_text::<&str>("turbo fish "); //! s1.append_text_impl_trait("impl trait"); //! s1.add_value(5, &mut tc1); //! assert_eq!(s1.get_text(), "simple turbo fish impl trait"); //! assert_eq!(tc1, TCounter(St::<u32>::C_TC + 1)); //! // ======== //! let mut tc2 = TCounter(St::<u32>::C_TC); //! let s2 = St::new(0u32, "".into()) //! .with_appended_text("simple ") //! .with_appended_text::<&str>("turbo fish ") //! .with_appended_text_impl_trait("impl trait") //! .with_added_value(5, &mut tc2); //! assert_eq!(s2, s1); //! assert_eq!(tc2, tc1); //! } //! ``` extern crate proc_macro; extern crate proc_macro2; #[macro_use] extern crate syn; // Required by parse_quote!{} #[macro_use] extern crate quote; mod config; mod impl_block; mod method; mod type_utils; use proc_macro::TokenStream; use proc_macro2::TokenStream as TokenStream2; use syn::{Attribute, ImplItem, ItemImpl}; use config::MacroConfig; // Dummy proc-macro for default overrides #[proc_macro_attribute] /// Check the top-level documentation of this crate pub fn fluent_impl_opts(_: TokenStream, input: TokenStream) -> TokenStream { check_if_impl_item_method(input.clone()).expect("Invalid fluent_impl_opts position"); input } #[proc_macro_attribute] /// Check the top-level documentation of this crate pub fn fluent_impl(args: TokenStream, input: TokenStream) -> TokenStream { let args: TokenStream2 = args.into(); let attr: Attribute = parse_quote! { #[fluent_impl(#args)] }; let attr_info = config::parse_config_from_attr(&attr).expect("Failed to parse macro attributes"); let macro_config = config::get_proc_macro_config(attr_info).expect("Failed to get config"); gen_fluent(input.into(), ¯o_config) .expect("Failed to generate fluent methods") .into() } fn check_if_impl_item_method(input: TokenStream) -> Result<(), String> { let err_msg = "only applies to methods in an impl block"; if let Ok(impl_item) = syn::parse::<ImplItem>(input) { match impl_item { ImplItem::Method(_) => (), _ => Err(err_msg)?, } } else { Err(err_msg)?; } Ok(()) } fn gen_fluent(input: TokenStream2, macro_config: &MacroConfig) -> Result<TokenStream2, String> { if let Ok(impl_block) = syn::parse2::<ItemImpl>(input) { impl_block::gen_fluent_from_impl_block(&impl_block, macro_config) } else { Err("fluent_impl only applies to impl blocks")? } }