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 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
/// Rewraps the tokens inside macro parameters into parentheses.
///
/// # Syntax
///
/// This macro transforms `~` immediately followed by a macro parameter
/// into its tokens wrapped in parentheses.
///
/// You can escape `~` by writing it twice (`~~`), returning a single `~` from the macro.
///
/// # Example
///
/// ```rust
/// pub use core_extensions::rewrap_macro_parameters;
///
/// crate::constify!{
/// pub fn foo() -> u32 {
/// 100
/// }
/// pub unsafe fn bar() -> u32 {
/// 200
/// }
/// }
///
/// const X: &[u32] = unsafe{ &[foo(), bar()] };
///
/// fn main() {
/// assert_eq!(X, &[100, 200]);
/// }
///
/// #[macro_export]
/// macro_rules! constify {
/// ($($item:item)*) => {
/// rewrap_macro_parameters!{
/// $crate::__priv_constify_inner!{
/// hello world ~~~~
/// // `__priv_constify_inner` can't destructure `$item`,
/// // so you need to use `rewrap_macro_parameters` and prefix the parameter with
/// // `~` to rewrap its tokens in parentheses
/// $(~$item)*
/// }
/// }
/// }
/// }
///
/// #[macro_export]
/// #[doc(hidden)]
/// macro_rules! __priv_constify_inner{
/// (
/// hello world ~ ~
/// $((
/// $(#[$attr:meta])*
/// $vis:vis
/// $(unsafe $(@$unsafe:tt@)?)?
/// fn
/// $($rem:tt)*
/// ))*
/// ) => {
/// $(
/// $(#[$attr])*
/// $vis const $(unsafe $(@$unsafe@)?)? fn
/// $($rem)*
/// )*
/// }
/// }
///
///
///
/// ```
///
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
#[macro_export]
macro_rules! rewrap_macro_parameters {
(
$($tokens:tt)*
) => {
$crate::__::__priv_rewrap_macro_parameters!{
$($tokens)*
}
};
}
#[doc(hidden)]
#[macro_export]
macro_rules! __priv_usize_const {
($value:literal) => {
pub const __USIZE_CONST: $crate::__::usize = $value;
};
}
if_rust_1_46!{
/// Counts the amount of token trees passed to this macro,
/// passing the amount to an (optional) callback macro.
///
///
/// Note that macro parameters (eg: `$foo`) are one token tree,
/// and matched pairs of `[]`/`()`/`{}` count as one token tree regardless of
/// the tokens inside.
///
/// # Callback
///
/// You need to pass a callback macro whenever the macro expects a literal.
///
/// If you only need the count for an expression(ie: the length of an array),
/// then no callback macro is necessary.
///
/// # Version compatibility
///
/// This macro requires Rust 1.45.0 to be invoked with a callback parameter,
/// inside an expression.
///
/// # Example
///
/// ```rust
/// use core_extensions::count_tts;
///
/// fn main() {
/// // The counted tokens must be wrapped in parentheses,
/// // otherwise passing a callback macro would be syntactically ambiguous.
/// assert_eq!(count_tts!(()), 0);
/// assert_eq!(count_tts!((zero)), 1);
/// assert_eq!(count_tts!((zero one)), 2);
/// assert_eq!(count_tts!((zero (one two three) four)), 3);
///
/// assert_eq!(hello(), "hello");
/// }
///
/// macro_rules! expects_5{
/// (
/// foo $ident:ident baz
/// 5
/// ) => {
/// fn $ident() -> &'static str {
/// stringify!($ident)
/// }
/// }
/// }
///
/// // Calls the `expects_5` macro.
/// count_tts!{
/// // The invoked macro, and the first arguments passed to it
/// expects_5!{foo hello baz}
///
/// // The token trees to count
/// (a [b c d] (e f) {g h i} 10 )
/// }
/// ```
///
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
=>
(
#[macro_export]
macro_rules! count_tts {
($parentheses:tt) => {{
mod __ {
$crate::__::count_tts!{
$crate::__priv_usize_const!{}
$parentheses
}
}
__::__USIZE_CONST
}};
($($everything:tt)*) => {
$crate::__::count_tts!{$($everything)*}
};
}
)
(
pub use core_extensions_proc_macros::count_tts;
)
}
/// Generates identifiers. passing them to a callback macro.
///
/// # Repetition Syntax
///
/// The syntax for describing the generated identifiers:
///
/// `for <ident> * in <range>`
///
/// Where `<ident>` is any valid identifier.
///
/// Where `<range>` can be either `<number> .. <number>` or `<number> ..= <number>`.
///
/// <span id = "number-syntax"></span>
/// Where `<number>` can be any of:
///
/// - An integer literal
///
/// - `count(....)`: Which counts the amount of token trees in `(....)`.
/// Macro parameters (eg: `$foo`) are one token tree,
/// and matched pairs of `[]`/`()`/`{}` count as one token tree regardless of
/// the tokens inside.
///
/// [`count_tts`]: ./macro.count_tts.html
///
/// # Version compatibility
///
/// This macro requires Rust 1.45.0 to be invoked inside of a function.
///
/// # Example
///
/// ### Basic
///
/// Basic examples of using this macro, and what it passes to a callback macro.
///
/// For a more realistic example you can look [at the one below](#realistic-example)
///
/// ```rust
/// use core_extensions::gen_ident_range;
///
/// fn main() {
/// assert_eq!(hello(), "world");
/// assert_eq!(foo(), "bar");
/// }
///
/// // Calls the `expected_0_to_2` macro.
/// gen_ident_range!{
/// crate::expected_0_to_2!{hello "world"}
/// for stuff_* in 0..3
/// }
///
/// // Calls the `expected_1_to_4` macro.
/// gen_ident_range!{
/// crate::expected_1_to_4!{foo "bar" baz}
/// // `count(....)` here counts 4 token trees
/// for pre_* in 1..=count(a (b c) [d e f] {g h i j})
/// }
///
/// #[macro_export]
/// macro_rules! expected_0_to_2{
/// ($func:ident $lit:literal (stuff_0 stuff_1 stuff_2)) => {
/// fn $func() -> &'static str {
/// $lit
/// }
/// }
/// }
///
/// #[macro_export]
/// macro_rules! expected_1_to_4{
/// ($func:ident $lit:literal baz (pre_1 pre_2 pre_3 pre_4)) => {
/// fn $func() -> &'static str {
/// $lit
/// }
/// }
/// }
/// ```
///
/// <div id = "realistic-example"></div>
///
/// ### More Realistic Example
///
/// ```rust
/// use core_extensions::gen_ident_range;
///
/// fn main() {
/// assert_eq!(add_unsigned(3, 5, 8), 16);
/// assert_eq!(add_signed(-3, 8), 5);
///
/// }
///
/// adder_fn!{ pub fn add_unsigned(u16, u32, u64) -> u64 }
/// adder_fn!{ fn add_signed(i8, i16) -> i64 }
///
///
///
/// #[macro_export]
/// macro_rules! adder_fn {
/// ($vis:vis fn $func:ident ($($arg_ty:ty),* $(,)?) -> $ret_ty:ty) => {
/// gen_ident_range!{
/// $crate::__priv_adder_fn!{
/// ($vis fn $func ($($arg_ty,)*) -> $ret_ty)
/// }
/// for arg_* in 0..count($($arg_ty)*)
/// }
/// }
/// }
///
/// #[macro_export]
/// macro_rules! __priv_adder_fn {
/// (
/// ($vis:vis fn $func:ident ($($arg_ty:ty,)*) -> $ret_ty:ty)
/// ($($arg:ident)*)
/// ) => {
/// $vis fn $func($($arg: $arg_ty,)*) -> $ret_ty {
/// // assuming that Default::default is zero or empty
/// <$ret_ty as $crate::__::Default>::default()
/// $(
/// + <$ret_ty as $crate::__::From<_>>::from($arg)
/// )*
/// }
/// }
/// }
///
///
/// #[doc(hidden)]
/// pub mod __ {
/// pub use core_extensions::gen_ident_range;
///
/// pub use std::convert::From;
/// pub use std::default::Default;
/// }
///
/// ```
///
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
pub use core_extensions_proc_macros::gen_ident_range;
/// For using function-like macros as attributes.
///
/// # Examples
///
/// ### Module
///
/// ```rust
/// use core_extensions::macro_attr;
///
/// fn main() {
/// assert_eq!(hello::Hello(3, 5).sum(), 8);
/// assert_eq!(hello::Hello(13, 21).sum(), 34);
/// }
///
/// #[macro_attr(in_mod!(pub mod hello;))]
/// #[derive(Debug, PartialEq)]
/// pub struct Hello(pub u32, pub u32);
///
/// impl hello::Hello {
/// const fn sum(&self) -> u64 {
/// self.0 as u64 + self.1 as u64
/// }
/// }
///
/// #[macro_export]
/// macro_rules! in_mod {
/// (
/// $(#[$attr:meta])*
/// $vis:vis mod $module:ident;
///
/// $($item:item)*
/// ) => {
/// $(#[$attr])*
/// $vis mod $module {
/// $($item)*
/// }
/// }
/// }
///
/// ```
///
/// ### Item count
///
/// This example only works from 1.46.0 onwards, not sure why.
///
#[cfg_attr(feature = "rust_1_46", doc = "```rust")]
#[cfg_attr(not(feature = "rust_1_46"), doc = "```ignore")]
/// use core_extensions::macro_attr;
///
/// fn main() {
/// assert_eq!(items::COUNT, 4);
///
/// assert_eq!(items::foo(), 3);
/// assert_eq!(items::BAR, 5);
/// }
///
/// #[macro_attr(crate::and_item_count)]
/// pub mod items {
/// pub fn foo() -> u32 {
/// 3
/// }
///
/// pub const BAR: u32 = 5;
///
/// pub struct Baz;
///
/// pub struct Qux {
/// pub x: u64,
/// pub y: u64,
/// }
/// }
///
/// #[macro_export]
/// macro_rules! and_item_count {
/// (
/// $(#[$attr:meta])*
/// $vis:vis mod $module:ident {
/// $($item:item)*
/// }
/// ) => {
/// $(#[$attr])*
/// $vis mod $module {
/// pub const COUNT: usize = $crate::__::count_tts!(($($item)*));
///
/// $($item)*
/// }
/// }
/// }
///
/// #[doc(hidden)]
/// mod __ {
/// pub use core_extensions::count_tts;
/// }
/// ```
///
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
pub use core_extensions_proc_macros::macro_attr;
/// Stringifies the input tokens, and errors with `compile_error`.
///
/// Ỳou can use this to show the tokens passed to a macro.
#[macro_export]
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
macro_rules! compile_error_stringify {
($($tt:tt)*) => {
$crate::__::compile_error!{
$crate::__::stringify!($($tt)*)
}
};
}
include!{"./macro_utils/tokens_method.rs"}
/// Adaptor macro which passes arguments to a callback macro, wrapping them in parentheses.
///
/// # Example
///
/// ```rust
/// use core_extensions::{count_tts, parenthesize_args};
///
///
/// fn main() {
/// assert_eq!(foo(), 5);
/// }
///
/// macro_rules! the_macro {
/// ($func:ident $count:literal) => {
/// pub fn $func() -> u32 { $count }
/// }
/// }
///
/// // `parenthesize_args` invokes `count_tts` here,
/// // then `count_tts` counts `a b c d e` as having 5 tokens,
/// // passing `5` as the `$count` parameter to `the_macro`.
/// parenthesize_args!{
/// count_tts!{
/// the_macro!{foo}
/// }
/// a b c d e
/// }
///
/// ```
#[macro_export]
#[cfg_attr(feature = "docsrs", doc(cfg(feature = "macro_utils")))]
macro_rules! parenthesize_args {
(
$(:: $(@$leading:tt@)? )? $first:ident $(:: $trailing:ident)* ! { $($prefix:tt)* }
$($extra:tt)*
) => {
$(:: $(@$leading@)? )? $first $(:: $trailing)* ! {
$($prefix)*
($($extra)*)
}
};
}