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
//Copyright (c) 2019-2024 #UlinProject Denis Kotlyarov (Денис Котляров)
//-----------------------------------------------------------------------------
//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
// limitations under the License.
//-----------------------------------------------------------------------------
// or
//-----------------------------------------------------------------------------
//Permission is hereby granted, free of charge, to any person obtaining a copy
//of this software and associated documentation files (the "Software"), to deal
//in the Software without restriction, including without limitation the rights
//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//copies of the Software, and to permit persons to whom the Software is
//furnished to do so, subject to the following conditions:
//The above copyright notice and this permission notice shall be included in all
//copies or substantial portions of the Software.
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//SOFTWARE.
// #Ulin Project 1819 2022 2024
/*!
A convenient macro, for cloning values into a closure.
### Use
Just use it!
```rust
use enclose::enclose;
fn main() {
let clone_data = 0;
let add_data = 100;
my_enclose( enclose!((mut clone_data, add_data) || {
// (mut clone_data, add_data) ->
// let mut clone_data = clone_data.clone();
// let add_data = add_data.clone();
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(clone_data, 0);
}
fn my_enclose<F: FnOnce() -> R, R>(a: F) -> R {
a()
}
```
### MutexUse
Creating closures for a multi-threaded environment, no extra lines!
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::thread;
use enclose::enclose;
fn main() {
let mutex_data = Arc::new(Mutex::new( 0 ));
let thread = thread::spawn( enclose!((mutex_data => d) move || {
// (mutex_data => d) ->
// let d = mutex_data.clone();
let mut lock = match d.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*lock += 1;
}));
thread.join().unwrap();
{
let lock = match mutex_data.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*lock, 1);
}
}
```
### ArcMutexUse
A more complex example of using an enclose macro in a multi-threaded environment.
```rust
use std::sync::Arc;
use std::sync::Mutex;
use std::sync::RwLock;
use std::thread;
use enclose::enclose;
fn main() {
let data1 = Arc::new(Mutex::new( 0 ));
let data2 = Arc::new(RwLock::new( (0, 2, 3, 4) ));
let count_thread = 5;
let mut waits = Vec::with_capacity(count_thread);
for _a in 0..count_thread {
waits.push({
thread::spawn( enclose!((data1, data2) move || {
// (data1, data2) ->
// let data1 = data1.clone();
// let data2 = data2.clone();
let mut v_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
*v_lock += 1;
drop( data2 ); // ignore warning
}))
});
}
for a in waits {
a.join().unwrap();
}
{
// Check data1_lock
let data1_lock = match data1.lock() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data1_lock, 5);
}
{
// Check data2_lock
let data2_lock = match data2.write() {
Ok(a) => a,
Err(e) => e.into_inner(),
};
assert_eq!(*data2_lock, (0, 2, 3, 4));
}
}
```
### EasyCopy
Using copy instead of clone.
```rust
use enclose::enclose;
use std::sync::Arc;
fn main() {
let clone_data = Arc::new(0);
let add_data = Arc::new(100);
my_enclose( enclose!((mut *clone_data, *add_data) || {
// (mut *clone_data, *add_data)
// let mut clone_data = *clone_data;
// let add_data = *add_data;
println!("#0 {:?}", clone_data);
clone_data += add_data;
println!("#1 {:?}", clone_data);
assert_eq!(clone_data, 100);
}));
assert_eq!(*clone_data, 0);
}
fn my_enclose<F: FnOnce() -> R, R>(a: F) -> R {
a()
}
```
*/
#![no_std]
#![allow(clippy::tabs_in_doc_comments)]
#![allow(clippy::needless_doctest_main)]
mod var;
/// A macro for creating a closure, as well as cloning,
/// copying values into the closure.
///
/// ## Args Support
///
/// A list of all possible arguments that can be written, separated by commas,
/// in the arguments to the macro.
///
/// ### `.clone()` operation
/// ```code
/// // (a => mut b: String) will be converted to (let mut b: String = a.clone();)
/// // (b => mut b)
/// // (a => b: usize)
/// // (a => b)
/// // (mut a: String)
/// // (mut a)
/// // (a: String)
/// // (a)
/// ```
///
/// ### `*copy` operation
/// ```code
/// // (*a => mut b: &str) will be converted to (let mut b: &str = *a;)
/// // (*a => mut b)
/// // (*a => b: &str)
/// // (*a => b)
/// // (mut *a: &str)
/// // (mut *a)
/// // (*a: &str)
/// // (*a)
/// ```
///
/// ### `let ref mut a = b;` (`ref`) operation
/// ```code
/// // (ref mut a: String) will be converted to (let ref mut a: String = a;)
/// // (ref mut a)
/// // (ref a: String)
/// // (ref a)
/// // (ref a => mut b: String)
/// // (ref a => mut b)
/// // (ref a => b: String)
/// // (ref a => b)
/// ```
///
/// ### `(1+1)` (expr) operation
/// ```code
/// // (@(1+1) => mut b: usize) will be converted to (let mut b: usize = (1+1);)
/// // (@(1+1) => mut b)
/// // (@(1+1) => b: usize)
/// // (@(1+1) => b)
/// ```
///
/// ### `let a = b;` (move) operation
/// ```code
/// // (move a => mut b: String) will be converted to (let mut b: String = a;)
/// // (move a => mut b)
/// // (move a => mut b)
/// // (move a => b: String)
/// // (move a => b)
/// // (move mut a: String)
/// // (move mut a)
/// // (move a: String)
/// // (move a)
/// ```
///
/// ### `{println!("test");}` (run) operation
/// ```code
/// // { panic!("12"); }
/// ```
///
/// ## Example
///
/// ### JustUse
///
/// ```rust
/// use enclose::enclose;
///
///fn main() {
/// let clone_data = 0;
/// let add_data = 100;
///
/// my_enclose(enclose!((mut clone_data, add_data) || {
/// // (mut clone_data, add_data) ->
/// // let mut clone_data = clone_data.clone();
/// // let add_data = add_data.clone();
///
/// println!("#0 {:?}", clone_data);
/// clone_data += add_data;
/// println!("#1 {:?}", clone_data);
///
/// assert_eq!(clone_data, 100);
/// }));
///
/// assert_eq!(clone_data, 0);
///}
///
///#[inline]
///fn my_enclose<F: FnOnce() -> R, R>(a: F) -> R {
/// a()
///}
///```
///
/// ### Expr
///
///```rust
///use enclose::enclose;
///use std::sync::Arc;
///
///fn main() {
/// let clone_data = Arc::new(0);
/// let add_data = Arc::new(100);
///
/// // I also note that any expressions can be used, but the main thing is to
/// // put the @ symbol at the beginning of the variable, and not forget to assign
/// // a new name to the variable using =>.
/// my_enclose(
/// enclose!((@*clone_data => mut clone_data: usize, @*(add_data.clone()) => add_data) || {
/// // (@*clone_data => mut clone_data, @*(add_data.clone()) => add_data) ->
/// // let mut clone_data = *clone_data;
/// // let add_data = *(add_data.clone());
///
/// println!("#0 {:?}", clone_data);
/// clone_data += add_data;
/// println!("#1 {:?}", clone_data);
///
/// assert_eq!(clone_data, 100);
/// }),
/// );
///
/// assert_eq!(*clone_data, 0);
///}
///
///#[inline]
///fn my_enclose<F: FnOnce() -> R, R>(a: F) -> R {
/// a()
///}
/// ```
///
#[macro_export]
macro_rules! enclose {
[
// (a, b) move || true
( $($enc_args:tt)* ) move || $($b:tt)*
] => {{ // move, empty args
$crate::enclose_var! {
$( $enc_args )*
}
move || $($b)*
}};
[
// (a, b) move |c, d| true
( $($enc_args:tt)* ) move | $($args:tt),* | $($b:tt)*
] => {{ // move, args
$crate::enclose_var! {
$( $enc_args )*
}
move | $($args),* | $($b)*
}};
[
// (a, b) || true
( $($enc_args:tt)* ) || $($b:tt)*
] => {{ // empty args
|| {
$crate::enclose_var! {
$( $enc_args )*
}
$($b)*
}
}};
[
// (a, b) |c, d| true
( $($enc_args:tt)* ) | $($args:tt),* | $($b:tt)*
] => {{ // args
| $($args),* | {
$crate::enclose_var! {
$( $enc_args )*
}
$($b)*
}
}};
[
// (a, b) true
( $($enc_args:tt)* ) $($all:tt)*
] => {{ // empty
$crate::enclose_var! {
$( $enc_args )*
}
$($all)*
}};
/*[ $($unk:tt)+ ] => {
compile_error!("Undefined entry or unsupported arguments, please double-check input.");
};*/
[] => {};
}
/// A macro for creating a closure, as well as cloning,
/// copying values into the closure.
///
/// Alternative short record `enclose`.
#[macro_export]
macro_rules! enc {
[
// (a, b) move || true
// (a, b) move |c, d| true
// (a, b) || true
// (a, b) |c, d| true
// (a, b) true
$($tt:tt)*
] => {
$crate::enclose! {
$($tt)*
}
};
}