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

//! This library provides [`fixed!`][fm-fixed], a proc-macro that allows
//! easily creating fixed-point constants for all of the fixed-point types provided in
//! [`fixed`][fixed] crate.
//!
//! ```toml
//! [dependencies]
//! fixed-macro = "1.1"
//! ```
//!
//! *Compiler support: rustc 1.45+.*
//!
//! [fixed]: https://docs.rs/fixed
//! [fixed-types]: https://docs.rs/fixed/latest/fixed/types/index.html
//! [fm-fixed]: macro.fixed.html
//! [fm-types]: types/index.html
//!
//! ## Details
//!
//! - The syntax of the macro is as follows:
//!
//! ```ignore
//! fixed!(<value>: <type>)
//! ```
//!
//! where `<value>` is an integer literal or a float literal, and `<type>` is either of the
//! form `I<i>F<f>` or `U<i>F<f>`, matching one of the type aliases provided in
//! [`fixed::types`][fixed-types]. Note in particular that `<value>` has to be a literal and
//! not an arbitrary arithmetic expression, and that `<type>` is considered a special identifier,
//! so that it doesn't have to be imported first.
//!
//! - Create a fixed-point constant which is parsed at compile time (the same syntax for int
//! and float literals is supported as in Rust itself, including underscores and scientific
//! notation):
//!
//! ```rust
//! use fixed_macro::fixed;
//! use fixed::types::U8F8;
//!
//! let x1 = fixed!(-1.23: I32F32);         // float literal (note, the type is not in scope)
//! const X2: U8F8 = fixed!(1.2: U8F8);     // can be used to initialize const values
//! let x3 = fixed!(123: U8F8);             // decimal integers work as well
//! let x4 = fixed!(0x7B: U8F8);            // and hex/oct/bin integers too
//! let x5 = fixed!(1_234.567_890: I32F32); // underscores are ignored, same as in rustc
//! let x7 = fixed!(0.12e+01: U8F8);        // scientific notation is also supported
//! ```
//!
//! - For each type alias from [`fixed::types`][fixed-types], there is a macro with a matching
//! name in [`fixed_macro::types`][fm-types] which you can use without specifying the type name:
//!
//! ```rust
//! use fixed_macro::types::I16F48;
//!
//! let a1 = I16F48!(-1.23);
//! ```
//!
//! Both the macro and the type can happily coexist in the same scope:
//!
//! ```rust
//! use fixed::types::I16F48;
//! use fixed_macro::types::I16F48;
//!
//! const B1: I16F48 = I16F48!(1.23e-2);
//! ```
//!
//! You can choose to import both under different (or same) user-defined names:
//!
//! ```rust
//! use fixed::types::{I16F48 as Decimal};
//! use fixed_macro::types::{I16F48 as dec};
//!
//! let c1 = dec!(12_345);
//! const C2: Decimal = dec!(-0.123_456);
//! ```

pub use fixed_macro_impl::fixed;

/// Macros allowing to create constants for each available fixed-point type.
pub mod types {
    pub use fixed_macro_types::*;
}

// Not public API. Used by generated code.
#[doc(hidden)]
pub use fixed as __fixed;