defmt_macros/
lib.rs

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
//! INTERNAL; DO NOT USE. Please use the `defmt` crate to access the functionality implemented here

#![doc(html_logo_url = "https://knurling.ferrous-systems.com/knurling_logo_light_text.svg")]

use defmt_parser::Level;
use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use proc_macro_error2::proc_macro_error;
use quote::quote;

mod attributes;
mod cargo;
mod construct;
mod consts;
mod derives;
mod function_like;
mod items;

// NOTE some proc-macro functions have an `_` (underscore) suffix. This is intentional.
// If left unsuffixed the procedural macros would shadow macros defined in `std` (like `assert`)
// within the context of this entire crate, which leads to lots of confusion.

/* # Attributes */
#[proc_macro_attribute]
#[proc_macro_error]
pub fn global_logger(args: TokenStream, item: TokenStream) -> TokenStream {
    attributes::global_logger::expand(args, item)
}

#[proc_macro_attribute]
#[proc_macro_error]
pub fn panic_handler(args: TokenStream, item: TokenStream) -> TokenStream {
    attributes::panic_handler::expand(args, item)
}

/* # Derives */
#[proc_macro_derive(Format, attributes(defmt))]
#[proc_macro_error]
pub fn format(input: TokenStream) -> TokenStream {
    derives::format::expand(input)
}

/* # Function-like */
#[proc_macro]
#[proc_macro_error]
pub fn assert_(args: TokenStream) -> TokenStream {
    function_like::assert_like::assert::expand(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn assert_eq_(args: TokenStream) -> TokenStream {
    function_like::assert_binop::eq(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn assert_ne_(args: TokenStream) -> TokenStream {
    function_like::assert_binop::ne(args)
}

/* ## `debug_` variants */
// NOTE these `debug_*` macros can be written using `macro_rules!` (that'd be simpler) but that
// results in an incorrect source code location being reported: the location of the `macro_rules!`
// statement is reported. Using a proc-macro results in the call site being reported, which is what
// we want
#[proc_macro]
#[proc_macro_error]
pub fn debug_assert_(input: TokenStream) -> TokenStream {
    let assert = TokenStream2::from(assert_(input));
    quote!(if cfg!(debug_assertions) {
        #assert
    })
    .into()
}

#[proc_macro]
#[proc_macro_error]
pub fn debug_assert_eq_(input: TokenStream) -> TokenStream {
    let assert = TokenStream2::from(assert_eq_(input));
    quote!(if cfg!(debug_assertions) {
        #assert
    })
    .into()
}

#[proc_macro]
#[proc_macro_error]
pub fn debug_assert_ne_(input: TokenStream) -> TokenStream {
    let assert = TokenStream2::from(assert_ne_(input));
    quote!(if cfg!(debug_assertions) {
        #assert
    })
    .into()
}
/* ## end of `debug_` variants */

#[proc_macro]
#[proc_macro_error]
pub fn dbg(args: TokenStream) -> TokenStream {
    function_like::dbg::expand(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn intern(args: TokenStream) -> TokenStream {
    function_like::intern::expand(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn internp(args: TokenStream) -> TokenStream {
    function_like::internp::expand(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn println(args: TokenStream) -> TokenStream {
    function_like::println::expand(args)
}

/* ## Logging macros */

#[proc_macro]
#[proc_macro_error]
pub fn trace(args: TokenStream) -> TokenStream {
    function_like::log::expand(Level::Trace, args)
}

#[proc_macro]
#[proc_macro_error]
pub fn debug(args: TokenStream) -> TokenStream {
    function_like::log::expand(Level::Debug, args)
}

#[proc_macro]
#[proc_macro_error]
pub fn info(args: TokenStream) -> TokenStream {
    function_like::log::expand(Level::Info, args)
}

#[proc_macro]
#[proc_macro_error]
pub fn warn(args: TokenStream) -> TokenStream {
    function_like::log::expand(Level::Warn, args)
}

#[proc_macro]
#[proc_macro_error]
pub fn error(args: TokenStream) -> TokenStream {
    function_like::log::expand(Level::Error, args)
}
/* ## end of logging macros */

#[proc_macro]
#[proc_macro_error]
pub fn panic_(args: TokenStream) -> TokenStream {
    function_like::panic_like::expand(args, "panicked at 'explicit panic'", |format_string| {
        format!("panicked at '{format_string}'")
    })
}

#[proc_macro]
#[proc_macro_error]
pub fn todo_(args: TokenStream) -> TokenStream {
    function_like::panic_like::expand(args, "panicked at 'not yet implemented'", |format_string| {
        format!("panicked at 'not yet implemented: {format_string}'")
    })
}

#[proc_macro]
#[proc_macro_error]
pub fn unreachable_(args: TokenStream) -> TokenStream {
    function_like::panic_like::expand(
        args,
        "panicked at 'internal error: entered unreachable code'",
        |format_string| {
            format!(
                "panicked at 'internal error: entered unreachable code: {}'",
                format_string
            )
        },
    )
}

#[proc_macro]
#[proc_macro_error]
pub fn unwrap(args: TokenStream) -> TokenStream {
    function_like::assert_like::unwrap::expand(args)
}

#[proc_macro]
#[proc_macro_error]
pub fn write(args: TokenStream) -> TokenStream {
    function_like::write::expand(args)
}

/* # Items */
#[proc_macro]
#[proc_macro_error]
pub fn bitflags(ts: TokenStream) -> TokenStream {
    items::bitflags::expand(ts)
}

#[proc_macro]
#[proc_macro_error]
pub fn timestamp(args: TokenStream) -> TokenStream {
    items::timestamp::expand(args)
}