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
// Copyright 2017 Dmytro Milinevskyi <dmilinevskyi@gmail.com>

// 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.

/// Sets the log level.
///
/// Sets global log level if called without the arguments or
/// according to the specified path otherwise.
///
/// Optionally the ranges of the lines within the file could
/// be given.
/// In this case the full path to the file must be provided.
///
/// The logger spec might also be either [env_logger](https://doc.rust-lang.org/log/env_logger) spec or
/// a JSON string which defines global and per-module log level.
///
/// See documentation of the [spec](spec/index.html) module for the details.
///
/// See documentation for the [wp_get_level](macro.wp_get_level.html)
/// for more details on the log level hierarchy.
///
/// # Example
///
/// ```rust
/// #[macro_use]
/// extern crate woodpecker;
/// use woodpecker as wp;
///
/// fn main() {
///     wp_init!();
///
///     let logger = "foo::bar";
///
///     wp_set_level!(wp::LogLevel::INFO).unwrap();
///     wp_set_level!(wp::LogLevel::CRITICAL, logger).unwrap();
///
///     assert_eq!(wp_get_level!(^), wp::LogLevel::INFO);
///     assert_eq!(wp_get_level!(), wp::LogLevel::INFO);
///     assert_eq!(wp_get_level!(logger), wp::LogLevel::CRITICAL);
///
///     wp_set_level!(wp::LogLevel::WARN, this_file!(), [(line!() + 2, wp::EOF)]).unwrap();
///     assert_eq!(wp_get_level!(), wp::LogLevel::INFO);
///     assert_eq!(wp_get_level!(), wp::LogLevel::WARN);
///
///     wp_set_level!(wp::LogLevel::CRITICAL, this_file!()).unwrap();
///     let ranges = vec![(wp::BOF.into(), line!() + 2), (line!() + 4, wp::EOF.into())];
///     wp_set_level!(wp::LogLevel::WARN, this_file!(), ranges).unwrap();
///     assert_eq!(wp_get_level!(), wp::LogLevel::WARN);
///     assert_eq!(wp_get_level!(), wp::LogLevel::CRITICAL);
///     assert_eq!(wp_get_level!(), wp::LogLevel::WARN);
///
///     wp_set_level!(wp::LogLevel::TRACE, this_file!(), [(wp::BOF, wp::EOF)]).unwrap();
///     assert_eq!(wp_get_level!(), wp::LogLevel::TRACE);
///
///     let spec = format!(r#"{{
///                     "level": "debug",
///                     "modules": [
///                         {{
///                             "path": "foo"
///                         }},
///                         {{
///                             "path": "{}",
///                             "level": "notice"
///                         }},
///                         {{
///                             "path": "{}",
///                             "level": "critical",
///                             "lines": [[{}, {}]]
///                         }}
///                     ]
///                 }}"#,
///             this_file!(), this_file!(), line!() + 4, line!() + 100);
///     wp_set_level!(spec(&spec)).unwrap();
///     assert_eq!(wp_get_level!(^), wp::LogLevel::DEBUG);
///     assert_eq!(wp_get_level!(), wp::LogLevel::NOTICE);
///     assert_eq!(wp_get_level!("foo"), wp::LogLevel::TRACE);
///     assert_eq!(wp_get_level!(), wp::LogLevel::CRITICAL);
///
///     let spec = format!("critical,{},foo=info", this_file!());
///     wp_set_level!(spec(&spec)).unwrap();
///     assert_eq!(wp_get_level!(^), wp::LogLevel::CRITICAL);
///     assert_eq!(wp_get_level!(), wp::LogLevel::TRACE);
///     assert_eq!(wp_get_level!("foo"), wp::LogLevel::INFO);
/// }
///
/// ```
#[macro_export]
macro_rules! wp_set_level {
    ($level:expr, $logger:expr, [$(($from:expr, $to:expr)),*]) => {{
        let mut lranges = Vec::new();
        $(
            let (from, to): (u32, u32) = ($from.into(), $to.into());
            lranges.push((from, to));
        )*;
        wp_set_level!($level, $logger, lranges)
    }};

    ($level:expr, $logger:expr, $lranges:expr) => {{
        match $crate::line_range::prepare_ranges($level, &$lranges) {
            Ok(lranges) => {
                __wp_write_root!(set_level($level, $logger, lranges))
            },
            Err(err) => {
                let err: Result<(), String> = Err(err.to_string());
                err
            },
        }
    }};

    ($level:expr, $logger:expr) => {{
        __wp_write_root!(set_level($level, $logger, Vec::new()))
    }};

    (spec($spec:expr)) => {{
        match $crate::spec::parse($spec) {
            Ok(spec) => {
                if let Some(level) = spec.level {
                    let _ = wp_set_level!(level);
                }
                || -> Result<(), String> {
                    for module in &spec.modules {
                        if let Some(lranges) = module.lranges.as_ref() {
                            wp_set_level!(module.level, &module.path, lranges)?;
                        } else {
                            wp_set_level!(module.level, &module.path)?;
                        }
                    }
                    Ok(())
                }()
            },
            Err(err) => Err(err.to_string())
        }
    }};

    ($level:expr) => {{
        $crate::global::set_loggers(false);
        __wp_write_root!(reset_loggers());
        $crate::global::set_level($level);
        let ok: Result<(), String> = Ok(());
        ok
    }};
}

/// Gets the log level.
///
/// Returns global log level if called with `^` as an argument.
///
/// Returns log level according to the position (current path)
/// if called without any argument.
///
/// Returns log level for the requested path when it's passed as an argument.
///
/// The log levels are hierarchical.
///
/// It means that if, for example, there's a rule that states that the module `foo::bar`
/// has log level `WARN`, then all submodules inherit this log level.
/// At the same time another rule may override the inherited level.
/// For example, `foo::bar::qux@xyz.rs` has log level `DEBUG`.
///
/// If there's no exact match the rules of the parent are applied.
///
/// # Example
///
/// ```rust
/// #[macro_use]
/// extern crate woodpecker;
/// use woodpecker as wp;
///
/// fn main() {
///     wp_init!();
///
///     let logger = "foo::bar";
///
///     assert_eq!(wp_get_level!(^), wp::LogLevel::WARN);
///     assert_eq!(wp_get_level!(logger), wp::LogLevel::WARN);
///
///     wp_set_level!(wp::LogLevel::INFO).unwrap();
///     wp_set_level!(wp::LogLevel::CRITICAL, logger).unwrap();
///
///     assert_eq!(wp_get_level!(^), wp::LogLevel::INFO);
///     assert_eq!(wp_get_level!(logger), wp::LogLevel::CRITICAL);
///
///     // Since the logs follow the hierarchy following statements are valid.
///     assert_eq!(wp_get_level!("foo::bar::qux"), wp::LogLevel::CRITICAL);
///     assert_eq!(wp_get_level!("foo"), wp::LogLevel::INFO);
///
///     wp_set_level!(wp::LogLevel::CRITICAL, this_module!()).unwrap();
///     assert_eq!(wp_get_level!(), wp::LogLevel::CRITICAL);
///
///     wp_set_level!(wp::LogLevel::DEBUG, this_file!()).unwrap();
///     assert_eq!(wp_get_level!(), wp::LogLevel::DEBUG);
///
///     assert_eq!(wp_get_level!(^), wp::LogLevel::INFO);
///     assert_eq!(wp_get_level!(this_module!()), wp::LogLevel::CRITICAL);
///     assert_eq!(wp_get_level!(this_file!()), wp::LogLevel::DEBUG);
/// }
///
/// ```
#[macro_export]
macro_rules! wp_get_level {
    (^) => {{
        $crate::global::get_level()
    }};

    () => {{
        if $crate::global::has_loggers() {
            let path = this_file!();
            __wp_read_root!(get_level(path, line!()))
        } else {
            $crate::global::get_level()
        }
    }};

    ($logger:expr) => {{
        if $crate::global::has_loggers() {
            __wp_read_root!(get_level($logger, $crate::EOF.into()))
        } else {
            $crate::global::get_level()
        }
    }};
}

/// Registers a log record handler.
///
/// The handler takes a log record as an argument and pushes it into a custom sink.
///
/// By default if no log handler is registered `woodpecker` emits
/// log records into `stdout`.
///
/// If at least one handler is registered than the `stdout` handler
/// must be registered explicitly if it's still desired.
///
/// See the definition of the [`Handler`](handlers/type.Handler.html) type for the details.
///
/// # Example
/// In this example string "foo" will be logged three times into `stdout`
/// but only one caught by the log handler.
///
/// ```rust
/// #[macro_use]
/// extern crate woodpecker;
/// use woodpecker as wp;
///
/// use std::sync::{Arc, Mutex};
/// use std::ops::Deref;
///
/// fn main() {
///     wp_init!();
///
///     warn!("foo");
///     let out = Arc::new(Mutex::new(String::new()));
///     {
///         wp_register_handler!(wp::handlers::stdout::handler());
///         warn!("foo");
///         let out = out.clone();
///         wp_register_handler!(Box::new(move |record| {
///             out.lock().unwrap().push_str(record.msg().deref());
///         }));
///
///         warn!("foo");
///     }
///     if cfg!(feature = "test-thread-log") {
///         wp::sync();
///     }
///     assert_eq!(*out.lock().unwrap(), "foo".to_string());
/// }
///
/// ```
#[macro_export]
macro_rules! wp_register_handler {
    ($handler:expr) => {{
        __wp_write_root!(handler($handler));
    }};
}

/// Sets a log record formatter.
///
/// A [default](formatters/default/fn.formatter.html) formatter is used if not set explicitly.
///
/// The formatter function takes a log record as an argument and returns a string
/// that will be used as a return value of [Record::formatted](record/trait.Record.html#tymethod.formatted) function.
///
/// See the definition of the [Formatter](formatters/type.Formatter.html) type for the details.
///
/// # Example
///
/// ```rust
/// #[macro_use]
/// extern crate woodpecker;
/// use woodpecker as wp;
///
/// use std::sync::{Arc, Mutex};
/// use std::ops::Deref;
///
/// fn main() {
///     wp_init!();
///
///     wp_set_formatter!(Box::new(|record| {
///         format!("{}:{}", record.level(), record.msg())
///     }));
///     let out = Arc::new(Mutex::new(String::new()));
///     {
///         let out = out.clone();
///         wp_register_handler!(Box::new(move |record| {
///             out.lock().unwrap().push_str(record.formatted().deref());
///         }));
///
///         warn!("foo");
///     }
///     if cfg!(feature = "test-thread-log") {
///         wp::sync();
///     }
///     assert_eq!(*out.lock().unwrap(), "WARN:foo".to_string());
/// }
///
/// ```
#[macro_export]
macro_rules! wp_set_formatter {
    ($formatter:expr) => {{
        __wp_write_root!(formatter($formatter));
    }};
}