macro_utils/lib.rs
1// MIT License
2//
3// Copyright (c) 2018 Guillaume Gomez
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in all
13// copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21// SOFTWARE.
22
23//! Some useful and funny macros.
24//!
25//! To be able to use it, import is as follows:
26//!
27//! ```
28//! #[macro_use]
29//! extern crate macro_utils;
30//! # fn main() {}
31//! ```
32//!
33//! # Examples
34//!
35//! ```
36//! # #[macro_use] extern crate macro_utils;
37//! let s = "bateau";
38//!
39//! if_match! {
40//! s == "voiture" => println!("It rolls!"),
41//! s == "avion" => println!("It flies!"),
42//! s == "pieds" => println!("It walks!"),
43//! s == "fusée" => println!("It goes through space!"),
44//! s == "bateau" => println!("It moves on water!"),
45//! else => println!("I dont't know how it moves...")
46//! }
47//!
48//! let y = 4;
49//! let x = tern_c! { (y & 1 == 0) ? { "even" } : { "odd" } };
50//! let x = tern_python! { { "it's even" } if (y & 1 == 0) else { "it's odd" } };
51//! let x = tern_haskell! { if (y & 1 == 0) then { "it's even" } else { "it's odd" } };
52//! ```
53
54#[cfg(test)]
55#[macro_use]
56extern crate doc_comment;
57
58#[cfg(test)]
59doctest!("../README.md");
60
61#[macro_use]
62mod if_match;
63#[macro_use]
64mod tern_c;
65#[macro_use]
66mod tern_haskell;
67#[macro_use]
68mod tern_python;