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
//! # Place-macro
//! Macros you wish you had while you were writing your non-proc macro.
//!
//! This library privides some macros that make writing regural non-proc
//! macros much simpler, readable and with less dirty tricks.
//!
//! The main macro of this library is `place`. It is able to expand the macros
//! in this library in reverse expansion order.
//!
//! Every time I'm missing a proc macro while creating macro, I will add it
//! here :).
//!
//! ## Macros
//! + `place`: expands the following macros in reverse order, see below
//! - `ignore`: expands to nothing
//! - `identity`: expands to what is given, it bypasses the reverse order in
//! the `place` macro
//! - `dollar`: expands to dollar sign `$`
//! - `string`: concats the contents into single string, see the doc
//! - `identifier`: concats the contents into sintle identifier in the same way
//! asstring
//! - `head`: expands to the first token
//! - `tail`: expands to all but the first token
//! - `start`: expands to all but the last token
//! - `last`: expands to the last token
//! - `reverse`: expands to the tokens in reverse order
//! - `stringify`: expands to string of the input
//! - `replace_newline`: replaces all newlines and folowing whitespace in
//! literal with the given literal
//! - `str_replace`: replace in string literal
//! - `to_case`: change the case of a identifier
//!
//! ### The macro `place`
//! Expands the other macros inside in reverse order. The macros inside that
//! will be expanded are used with a different sintax: instead of calling a
//! macro as `string!("hello" "there")` you call it as
//! `__string__("hello" "there")`. One exception is the macro `dollar` that is
//! called without the parenthesis: `__dollar__` instead of `__dollar__()`.
//!
//! For some of the macros there are also shorter names:
//! - `__identity__` - `__id__`
//! - `__string__` - `__str__`
//! - `__dollar__` - `__s__`
//! - `__identifier__` - `__ident__`
//! - `__stringify__` - `__strfy__`
//! - `__replace_newline__` - `__repnl__`
//! - `__str_replace__` - `__repstr__`
//!
//! The macro `to_case` has simplified usage, the case of the macro call will
//! determine the case to which convert (e.g. `__ToCase__(my_ident)` will
//! expand to `MyIdent`). Possible variants:
//! - `__TOCASE__`
//! - `__tocase__`
//! - `__toCase__`
//! - `__ToCase__`
//! - `__to_case__`
//! - `__TO_CASE__`
//!
//! #### Example
//! The following passes:
//! ```rust
//! use place_macro::place;
//!
//! let res = place!(__string__(1 __string__(2 __identity__(3 __string__(4)))));
//! assert_eq!(res, "123__string__4");
//! ```
//!
//! Why is this useful?
//!
//! - You can generate identifiers in your macros:
//! ```rust
//! use place_macro::place;
//!
//! macro_rules! my_cool_macro {
//! ($name:ident -> $t:ty, $body:expr) => {
//! place! {
//! fn __identifier__(cool_ $name)() -> $t {
//! $body
//! }
//! }
//! };
//! }
//!
//! my_cool_macro! { foo -> &'static str, "cool!" }
//! // Expands to:
//! // ```
//! // fn cool_foo() -> &'static str {
//! // "cool!"
//! // }
//! // ```
//! ```
//! - You can generate strings as macro parameters in your macros:
//! ```rust
//! use place_macro::place;
//!
//! macro_rules! my_cool_macro {
//! ($name:ident -> $t:ty, $body:expr) => {
//! place! {
//! #[doc =
//! __string__(
//! "cool function called " $name ". Returns `"
//! __stringify__($t) "`."
//! )
//! ]
//! fn __identifier__(cool_ $name)() -> $t {
//! $body
//! }
//! }
//! };
//! }
//!
//! my_cool_macro! { foo -> &'static str, "cool!" }
//! // Expands to:
//! // ```
//! // #[doc = "cool function called foo. Returns `&'static str`."]
//! // fn cool_foo() -> &'static str {
//! // "cool!"
//! // }
//! // ```
//! ```
//! - Or you can even generate macros in your macros
//! ```rust
//! use place_macro::place;
//!
//! macro_rules! my_cooler_macro {
//! ($t:ident) => {
//! place! {
//! macro_rules! __identifier__(my_ $t _macro) {
//! (__dollar__ name:ident -> __dollar__ t:ty, __dollar__ body:expr) => {
//! place! {
//! #[doc =
//! __identity__(__string__)(
//! $t " function called " __dollar__ name ". Returns `"
//! __identity__(__stringify__)(__dollar__ t) "`."
//! )
//! ]
//! fn __identity__(__identifier__)($t __dollar__ name)() -> __dollar__ t {
//! __dollar__ body
//! }
//! }
//! };
//! }
//! }
//! };
//! }
//!
//! my_cooler_macro! { cool };
//! my_cool_macro! { foo -> &'static str, "cool!" }
//! // now you have the same function as in the previous example
//! ```
//! The last example was a little less readable, but you can see that you can do
//! a lot with this macro.
//!
//! ## Links
//! - **Author:** [BonnyAD9](https://github.com/BonnyAD9)
//! - **GitHub repository:** [BonnyAD/place_macro](https://github.com/BonnyAD9/place_macro)
//! - **Package:** [crates.io](https://crates.io/crates/place_macro)
//! - **Documentation:** [docs.rs](https://docs.rs/place_macro/latest/place_macro/)
//! - **My Website:** [bonnyad9.github.io](https://bonnyad9.github.io/)
/// Ignores all the input, as if there was nothing
///
/// # Examples
/// ```
/// use place_macro::ignore;
///
/// let mut i = 5;
/// ignore!(i = 10);
/// assert_eq!(i, 5);
/// ```
pub use place_macro_proc::ignore;
/// Returns exactly the given input
///
/// # Examples
/// ```
/// use place_macro::identity;
///
/// let mut i = 5;
/// identity!(i = 10);
/// assert_eq!(i, 10);
/// ```
pub use place_macro_proc::identity;
/// Expands to a single dollar sign, this has no use when it is used alone,
/// but it can be used in the `place` macro
pub use place_macro_proc::dollar;
/// Converts the input to string literal, literals are interpreted as their
/// values, punctuation and brackets are ignored and the rest is stringified.
///
/// # Examples
/// ```
/// use place_macro::string;
///
/// let s = string!("hello" + , ", " {(agent)} ' ' 0x2F);
/// assert_eq!(s, "hello, agent 47");
/// ```
pub use place_macro_proc::string;
/// Expans to the first token if present
///
/// # Examples
/// ```
/// use place_macro::head;
///
/// let n = head!(5 + 3 + 2);
/// assert_eq!(n, 5);
///
/// let n = head!((5 + 3) + 2);
/// assert_eq!(n, (5 + 3));
///
/// // expands to nothing
/// head!();
/// ```
pub use place_macro_proc::head;
/// Expands to all but the first token
///
/// # Examples
/// ```
/// use place_macro::tail;
///
/// let n = tail!(-5);
/// assert_eq!(n, 5);
///
/// let n = tail!((5 + 3) - 5);
/// assert_eq!(n, -5);
///
/// // expands to nothing
/// tail!((-5));
/// ```
pub use place_macro_proc::tail;
/// Expands to all but the last token
///
/// # Examples
/// ```
/// use place_macro::start;
///
/// let n = start!(5 + 3 +);
/// assert_eq!(n, 5 + 3);
///
/// // expands to nothing
/// start!();
/// ```
pub use place_macro_proc::start;
/// Expands to the last token
///
/// # Examples
/// ```
/// use place_macro::last;
///
/// let n = last!(5 + 3 + 2);
/// assert_eq!(n, 2);
///
/// // expands to nothing
/// last!();
/// ```
pub use place_macro_proc::last;
/// Reverses the passed tokens
///
/// # Examples
/// ```
/// use place_macro::reverse;
///
/// let n = reverse!(5 - 3);
/// assert_eq!(n, -2);
///
/// let n = reverse!((2 + 3) - 2);
/// assert_eq!(n, -3);
/// ```
pub use place_macro_proc::reverse;
/// Creates a identifier in the same way as the string macro creates string
/// literals.
///
/// # Example
/// ```
/// use place_macro::identifier;
///
/// let my = 5;
/// let var = 10;
/// let myvar = 1;
/// let n = identifier!(my + var);
/// assert_eq!(n, myvar);
/// ```
pub use place_macro_proc::identifier;
/// Should be same to the rust macro stringify
///
/// # Example
/// ```
/// use place_macro;
///
/// let a = place_macro::stringify!("hello" + , ", " {(agent)} ' ' 0x2F);
/// let b = stringify!("hello" + , ", " {(agent)} ' ' 0x2F);
/// assert_eq!(a, b);
/// ```
pub use place_macro_proc::stringify;
/// Replaces newlines and follwing whitespace in string literal with another
/// string.
///
/// # Example
/// ```
/// use place_macro::replace_newline;
///
/// let v = replace_newline!("hello
/// every body
/// ", ", ");
/// assert_eq!(v, "hello, every body, ");
/// ```
pub use place_macro_proc::replace_newline;
/// Replaces in string literal
///
/// # Examples
/// ```
/// use place_macro::str_replace;
///
/// let s = str_replace!("hello runtime replace", "runtime", "compile-time");
/// assert_eq!(s, "hello compile-time replace");
/// ```
pub use place_macro_proc::str_replace;
/// Converts the given identifier to the given case. Second argument is the
/// identifier and the first is string literal representing the target case.
/// The target case can be one of:
/// - `"TOCASE"`
/// - `"tocase"`
/// - `"toCase"`
/// - `"ToCase"`
/// - `"to_case"`
/// - `"TO_CASE"`
///
/// # Examples
/// ```
/// use place_macro::to_case;
///
/// let my_var = 5;
/// let MyVar = 10;
/// let n = to_case!("ToCase", my_var);
/// assert_eq!(n, MyVar);
/// ```
pub use place_macro_proc::to_case;
/// Evaluates the macros in this crate in reverse order
///
/// to minimize conflicts, the macros are refered to as `__macro__` where
/// macro is the name of the macro. Special case is the macro `dollar` that
/// doesn't have any arguments.
/// # Examples
/// ```
/// use place_macro::place;
///
/// place! {
/// pub fn __identifier__(my "_function")() -> bool {
/// true
/// }
/// }
/// assert!(my_function());
///
/// place! {
/// macro_rules! mac {
/// (__dollar__ var: literal) => {
/// __dollar__ var
/// }
/// }
/// }
/// assert_eq!("hi", mac!("hi"));
///
/// let res = place!(__string__(1 __string__(2 __identity__(3 __string__(4)))));
/// assert_eq!(res, "123__string__4");
/// ```
pub use place_macro_proc::place;