-
Notifications
You must be signed in to change notification settings - Fork 44
/
lib.rs
1202 lines (1169 loc) · 42.3 KB
/
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
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Generate README by gawk 'substr($0,1,3) == "//!"{print(substr($0,4))}' src/lib.rs
//! # Logger with smart widget for the `tui` crate
//!
//! ![Build Status](https://travis-ci.org/gin66/tui-logger.svg?branch=master)
//! ![dependency status](https://deps.rs/repo/github/gin66/tui-logger/status.svg?service=github)
//! ![Build examples](https://github.com/gin66/tui-logger/workflows/Build%20examples/badge.svg?service=github)
//!
//!
//! ## Demo of the widget
//!
//! [Demo](https://github.com/gin66/tui-logger/blob/master/doc/example.svg?raw=true)
//!
//! ## Documentation
//!
//! [Documentation](https://docs.rs/tui-logger/0.5.0/tui_logger/)
//!
//! ## Features
//!
//! - [X] Logger implementation for the `log` crate
//! - [X] Logger enable/disable detection via hash table (avoid string compare)
//! - [X] Hot logger code only copies enabled log messages with timestamp into a circular buffer
//! - [X] Widgets/move_message() retrieve captured log messages from hot circular buffer
//! - [X] Lost message detection due to circular buffer
//! - [X] Log filtering performed on log record target
//! - [X] Simple Widgets to view logs and configure debuglevel per target
//! - [X] Logging of enabled logs to file
//! - [X] Scrollback in log history
//! - [x] Title of target and log pane can be configured
//! - [X] `slog` support, providing a Drain to integrate into your `slog` infrastructure
//! - [ ] Allow configuration of target dependent loglevel specifically for file logging
//! - [ ] Avoid duplicating of target, module and filename in every log record
//! - [ ] Simultaneous modification of all targets' display/hot logging loglevel by key command
//!
//! ## Smart Widget
//!
//! Smart widget consists of two widgets. Left is the target selector widget and
//! on the right side the logging messages view scrolling up. The target selector widget
//! can be hidden/shown during runtime via key command.
//! The key command to be provided to the TuiLoggerWidget via transition() function.
//!
//! The target selector widget looks like this:
//!
//! ![widget](https://github.com/gin66/tui-logger/blob/master/doc/example.png?raw=true)
//!
//! It controls:
//!
//! - Capturing of log messages by the logger
//! - Selection of levels for display in the logging message view
//!
//! The two columns have the following meaning:
//!
//! - Code EWIDT: E stands for Error, W for Warn, Info, Debug and Trace.
//! + Inverted characters (EWIDT) are enabled log levels in the view
//! + Normal characters show enabled capturing of a log level per target
//! + If any of EWIDT are not shown, then the respective log level is not captured
//! - Target of the log events can be defined in the log e.g. `warn!(target: "demo", "Log message");`
//!
//! ## Smart Widget Key Commands
//! ```ignore
//! | KEY | ACTION
//! |----------|-----------------------------------------------------------|
//! | h | Toggles target selector widget hidden/visible
//! | f | Toggle focus on the selected target only
//! | UP | Select previous target in target selector widget
//! | DOWN | Select next target in target selector widget
//! | LEFT | Reduce SHOWN (!) log messages by one level
//! | RIGHT | Increase SHOWN (!) log messages by one level
//! | - | Reduce CAPTURED (!) log messages by one level
//! | + | Increase CAPTURED (!) log messages by one level
//! | PAGEUP | Enter Page Mode and scroll approx. half page up in log history.
//! | PAGEDOWN | Only in page mode: scroll 10 events down in log history.
//! | ESCAPE | Exit page mode and go back to scrolling mode
//! | SPACE | Toggles hiding of targets, which have logfilter set to off
//! ```
//!
//! The mapping of key to action has to be done in the application. The respective TuiWidgetEvent
//! has to be provided to TuiWidgetState::transition().
//!
//! Remark to the page mode: The timestamp of the event at event history's bottom line is used as
//! reference. This means, changing the filters in the EWIDT/focus from the target selector window
//! should work as expected without jumps in the history. The page next/forward advances as
//! per visibility of the events.
//!
//! ## Basic usage to initialize logger-system:
//! ```rust
//! #[macro_use]
//! extern crate log;
//! //use tui_logger;
//!
//! fn main() {
//! // Early initialization of the logger
//!
//! // Set max_log_level to Trace
//! tui_logger::init_logger(log::LevelFilter::Trace).unwrap();
//!
//! // Set default level for unknown targets to Trace
//! tui_logger::set_default_level(log::LevelFilter::Trace);
//!
//! // code....
//! }
//! ```
//!
//! For use of the widget please check examples/demo.rs
//!
//! ## `slog` support
//!
//! `tui-logger` provides a TuiSlogDrain which implements `slog::Drain` and will route all records
//! it receives to the `tui-logger` widget
//!
//! ## Applications using tui-logger
//!
//! * [wash](https://github.com/wasmCloud/wash)
//! * [rocker](https://github.com/atlassian/rocker)
//!
//! ## THANKS TO
//!
//! * [Florian Dehau](https://github.com/fdehau) for his great crate [tui-rs](https://github.com/fdehau/tui-rs)
//! * [Antoine Büsch](https://github.com/abusch) for providing the patches to tui-rs v0.3.0 and v0.6.0
//! * [Adam Sypniewski](https://github.com/ajsyp) for providing the patches to tui-rs v0.6.2
//! * [James aka jklong](https://github.com/jklong) for providing the patch to tui-rs v0.7
//! * [icy-ux](https://github.com/icy-ux) for adding slog support and example
//! * [alvinhochun](https://github.com/alvinhochun) for updating to tui 0.10 and crossterm support
//! * [brooksmtownsend](https://github.com/brooksmtownsend) Patch to remove verbose timestamp info
//!
#[macro_use]
extern crate lazy_static;
use std::collections::hash_map::Iter;
use std::collections::hash_map::Keys;
use std::collections::HashMap;
use std::fs::File;
use std::fs::OpenOptions;
use std::io;
use std::io::Write;
use std::mem;
use std::sync::Arc;
use chrono::{DateTime, Local};
use log::{Level, LevelFilter, Log, Metadata, Record};
use parking_lot::Mutex;
use tui::buffer::Buffer;
use tui::layout::{Constraint, Direction, Layout, Rect};
use tui::style::{Modifier, Style};
use tui::text::Spans;
use tui::widgets::{Block, Borders, Widget};
mod circular;
mod slog;
pub use crate::circular::CircularBuffer;
pub use crate::slog::TuiSlogDrain;
struct ExtLogRecord {
timestamp: DateTime<Local>,
level: Level,
target: String,
file: String,
line: u32,
msg: String,
}
fn advance_levelfilter(levelfilter: &LevelFilter) -> (Option<LevelFilter>, Option<LevelFilter>) {
match *levelfilter {
LevelFilter::Trace => (None, Some(LevelFilter::Debug)),
LevelFilter::Debug => (Some(LevelFilter::Trace), Some(LevelFilter::Info)),
LevelFilter::Info => (Some(LevelFilter::Debug), Some(LevelFilter::Warn)),
LevelFilter::Warn => (Some(LevelFilter::Info), Some(LevelFilter::Error)),
LevelFilter::Error => (Some(LevelFilter::Warn), Some(LevelFilter::Off)),
LevelFilter::Off => (Some(LevelFilter::Error), None),
}
}
/// LevelConfig stores the relation target->LevelFilter in a hash table.
///
/// The table supports copying from the logger system LevelConfig to
/// a widget's LevelConfig. In order to detect changes, the generation
/// of the hash table is compared with any previous copied table.
/// On every change the generation is incremented.
#[derive(Default)]
pub struct LevelConfig {
config: HashMap<String, LevelFilter>,
generation: u64,
origin_generation: u64,
}
impl LevelConfig {
/// Create an empty LevelConfig.
pub fn new() -> LevelConfig {
LevelConfig {
config: HashMap::new(),
generation: 0,
origin_generation: 0,
}
}
/// Set for a given target the LevelFilter in the table and update the generation.
pub fn set(&mut self, target: &str, level: LevelFilter) {
if let Some(lev) = self.config.get_mut(target) {
if *lev != level {
*lev = level;
self.generation += 1;
}
return;
}
self.config.insert(target.to_string(), level);
self.generation += 1;
}
/// Retrieve an iter for all the targets stored in the hash table.
pub fn keys(&self) -> Keys<String, LevelFilter> {
self.config.keys()
}
/// Get the levelfilter for a given target.
pub fn get(&self, target: &str) -> Option<&LevelFilter> {
self.config.get(target)
}
/// Retrieve an iterator through all entries of the table.
pub fn iter(&self) -> Iter<String, LevelFilter> {
self.config.iter()
}
/// Merge an origin LevelConfig into this one.
///
/// The origin table defines the maximum levelfilter.
/// If this table has a higher levelfilter, then it will be reduced.
/// Unknown targets will be copied to this table.
fn merge(&mut self, origin: &LevelConfig) {
if self.origin_generation != origin.generation {
for (target, origin_levelfilter) in origin.iter() {
if let Some(levelfilter) = self.get(target) {
if levelfilter <= origin_levelfilter {
continue;
}
}
self.set(target, *origin_levelfilter);
}
self.generation = origin.generation;
}
}
}
/// These are the sub-structs for the static TUI_LOGGER struct.
struct HotSelect {
hashtable: HashMap<u64, LevelFilter>,
default: LevelFilter,
}
struct HotLog {
events: CircularBuffer<ExtLogRecord>,
}
struct TuiLoggerInner {
hot_depth: usize,
events: CircularBuffer<ExtLogRecord>,
total_events: usize,
dump: Option<File>,
default: LevelFilter,
targets: LevelConfig,
}
struct TuiLogger {
hot_select: Mutex<HotSelect>,
hot_log: Mutex<HotLog>,
inner: Mutex<TuiLoggerInner>,
}
impl TuiLogger {
pub fn move_events(&self) {
// If there are no new events, then just return
if self.hot_log.lock().events.total_elements() == 0 {
return;
}
// Exchange new event buffer with the hot buffer
let mut received_events = {
let new_circular = CircularBuffer::new(self.inner.lock().hot_depth);
let mut hl = self.hot_log.lock();
mem::replace(&mut hl.events, new_circular)
};
let mut tli = self.inner.lock();
let total = received_events.total_elements();
let elements = received_events.len();
tli.total_events += total;
let mut consumed = received_events.take();
let mut reversed = Vec::with_capacity(consumed.len() + 1);
while let Some(log_entry) = consumed.pop() {
reversed.push(log_entry);
}
if total > elements {
// Too many events received, so some have been lost
let new_log_entry = ExtLogRecord {
timestamp: reversed[reversed.len() - 1].timestamp,
level: Level::Warn,
target: "TuiLogger".to_string(),
file: "?".to_string(),
line: 0,
msg: format!(
"There have been {} events lost, {} recorded out of {}",
total - elements,
elements,
total
),
};
reversed.push(new_log_entry);
}
let default_level = tli.default;
while let Some(log_entry) = reversed.pop() {
if tli.targets.get(&log_entry.target).is_none() {
tli.targets.set(&log_entry.target, default_level);
}
if let Some(ref mut file) = tli.dump {
if let Err(_e) = writeln!(
file,
"{}:{}:{}:{}:{}:{}",
&log_entry.timestamp.format("[%Y:%m:%d %H:%M:%S]"),
log_entry.level,
log_entry.target,
&log_entry.file,
log_entry.line,
&log_entry.msg
) {
// TODO: What to do in case of write error ?
}
}
tli.events.push(log_entry);
}
}
}
lazy_static! {
static ref TUI_LOGGER: TuiLogger = {
let hs = HotSelect {
hashtable: HashMap::with_capacity(1000),
default: LevelFilter::Info,
};
let hl = HotLog {
events: CircularBuffer::new(1000),
};
let tli = TuiLoggerInner {
hot_depth: 1000,
events: CircularBuffer::new(10000),
total_events: 0,
dump: None,
default: LevelFilter::Info,
targets: LevelConfig::new(),
};
TuiLogger {
hot_select: Mutex::new(hs),
hot_log: Mutex::new(hl),
inner: Mutex::new(tli),
}
};
}
/// Init the logger and record with `log` crate.
pub fn init_logger(max_level: LevelFilter) -> Result<(), log::SetLoggerError> {
log::set_max_level(max_level);
log::set_logger(&*TUI_LOGGER)
}
pub fn slog_drain() -> TuiSlogDrain {
TuiSlogDrain
}
/// Set the depth of the hot buffer in order to avoid message loss.
/// This is effective only after a call to move_events()
pub fn set_hot_buffer_depth(depth: usize) {
TUI_LOGGER.inner.lock().hot_depth = depth;
}
/// Move events from hot circular buffer to the main one.
/// If defined, log records will be written to file.
pub fn move_events() {
TUI_LOGGER.move_events();
}
/// Define filename for logging.
pub fn set_log_file(fname: &str) -> io::Result<()> {
OpenOptions::new()
.create(true)
.append(true)
.open(fname)
.map(|file| {
TUI_LOGGER.inner.lock().dump = Some(file);
})
}
/// Set default levelfilter for unknown targets of the logger
pub fn set_default_level(levelfilter: LevelFilter) {
TUI_LOGGER.hot_select.lock().default = levelfilter;
TUI_LOGGER.inner.lock().default = levelfilter;
}
/// Set levelfilter for a specific target in the logger
pub fn set_level_for_target(target: &str, levelfilter: LevelFilter) {
let h = fxhash::hash64(&target);
TUI_LOGGER.inner.lock().targets.set(target, levelfilter);
let mut hs = TUI_LOGGER.hot_select.lock();
hs.hashtable.insert(h, levelfilter);
}
impl Log for TuiLogger {
fn enabled(&self, metadata: &Metadata) -> bool {
let h = fxhash::hash64(metadata.target());
let hs = self.hot_select.lock();
if let Some(&levelfilter) = hs.hashtable.get(&h) {
metadata.level() <= levelfilter
} else {
metadata.level() <= hs.default
}
}
fn log(&self, record: &Record) {
if self.enabled(record.metadata()) {
let log_entry = ExtLogRecord {
timestamp: chrono::Local::now(),
level: record.level(),
target: record.target().to_string(),
file: record.file().unwrap_or("?").to_string(),
line: record.line().unwrap_or(0),
msg: format!("{}", record.args()),
};
self.hot_log.lock().events.push(log_entry);
}
}
fn flush(&self) {}
}
#[derive(Debug, Clone, PartialEq, Hash)]
pub enum TuiWidgetEvent {
SpaceKey,
UpKey,
DownKey,
LeftKey,
RightKey,
PlusKey,
MinusKey,
HideKey,
FocusKey,
PrevPageKey,
NextPageKey,
EscapeKey,
}
#[derive(Default)]
struct TuiWidgetInnerState {
config: LevelConfig,
nr_items: usize,
selected: usize,
opt_timestamp_bottom: Option<DateTime<Local>>,
opt_timestamp_next_page: Option<DateTime<Local>>,
opt_timestamp_prev_page: Option<DateTime<Local>>,
opt_selected_target: Option<String>,
opt_selected_visibility_more: Option<LevelFilter>,
opt_selected_visibility_less: Option<LevelFilter>,
opt_selected_recording_more: Option<LevelFilter>,
opt_selected_recording_less: Option<LevelFilter>,
offset: usize,
hide_off: bool,
hide_target: bool,
focus_selected: bool,
}
impl TuiWidgetInnerState {
pub fn new() -> TuiWidgetInnerState {
TuiWidgetInnerState::default()
}
fn transition(&mut self, event: &TuiWidgetEvent) {
use TuiWidgetEvent::*;
match *event {
SpaceKey => {
self.hide_off ^= true;
}
HideKey => {
self.hide_target ^= true;
}
FocusKey => {
self.focus_selected ^= true;
}
UpKey => {
if !self.hide_target && self.selected > 0 {
self.selected -= 1;
}
}
DownKey => {
if !self.hide_target && self.selected + 1 < self.nr_items {
self.selected += 1;
}
}
LeftKey => {
if let Some(selected_target) = self.opt_selected_target.take() {
if let Some(selected_visibility_less) = self.opt_selected_visibility_less.take()
{
self.config.set(&selected_target, selected_visibility_less);
}
}
}
RightKey => {
if let Some(selected_target) = self.opt_selected_target.take() {
if let Some(selected_visibility_more) = self.opt_selected_visibility_more.take()
{
self.config.set(&selected_target, selected_visibility_more);
}
}
}
PlusKey => {
if let Some(selected_target) = self.opt_selected_target.take() {
if let Some(selected_recording_more) = self.opt_selected_recording_more.take() {
set_level_for_target(&selected_target, selected_recording_more);
}
}
}
MinusKey => {
if let Some(selected_target) = self.opt_selected_target.take() {
if let Some(selected_recording_less) = self.opt_selected_recording_less.take() {
set_level_for_target(&selected_target, selected_recording_less);
}
}
}
PrevPageKey => self.opt_timestamp_bottom = self.opt_timestamp_prev_page,
NextPageKey => self.opt_timestamp_bottom = self.opt_timestamp_next_page,
EscapeKey => self.opt_timestamp_bottom = None,
}
}
}
/// This struct contains the shared state of a TuiLoggerWidget and a TuiLoggerTargetWidget.
#[derive(Default)]
pub struct TuiWidgetState {
inner: Arc<Mutex<TuiWidgetInnerState>>,
}
impl TuiWidgetState {
/// Create a new TuiWidgetState
pub fn new() -> TuiWidgetState {
TuiWidgetState {
inner: Arc::new(Mutex::new(TuiWidgetInnerState::new())),
}
}
pub fn set_level_for_target(&self, target: &str, levelfilter: LevelFilter) -> &TuiWidgetState {
self.inner.lock().config.set(target, levelfilter);
self
}
pub fn transition(&mut self, event: &TuiWidgetEvent) {
self.inner.lock().transition(event);
}
}
/// This is the definition for the TuiLoggerTargetWidget,
/// which allows configuration of the logger system and selection of log messages.
pub struct TuiLoggerTargetWidget<'b> {
block: Option<Block<'b>>,
/// Base style of the widget
style: Style,
style_show: Style,
style_hide: Style,
style_off: Option<Style>,
highlight_style: Style,
state: Arc<Mutex<TuiWidgetInnerState>>,
targets: Vec<String>,
}
impl<'b> Default for TuiLoggerTargetWidget<'b> {
fn default() -> TuiLoggerTargetWidget<'b> {
TUI_LOGGER.move_events();
TuiLoggerTargetWidget {
block: None,
style: Default::default(),
style_off: None,
style_hide: Style::default(),
style_show: Style::default().add_modifier(Modifier::REVERSED),
highlight_style: Style::default().add_modifier(Modifier::REVERSED),
state: Arc::new(Mutex::new(TuiWidgetInnerState::new())),
targets: vec![],
}
}
}
impl<'b> TuiLoggerTargetWidget<'b> {
pub fn block(mut self, block: Block<'b>) -> TuiLoggerTargetWidget<'b> {
self.block = Some(block);
self
}
fn opt_style(mut self, style: Option<Style>) -> TuiLoggerTargetWidget<'b> {
if let Some(s) = style {
self.style = s;
}
self
}
fn opt_style_off(mut self, style: Option<Style>) -> TuiLoggerTargetWidget<'b> {
if style.is_some() {
self.style_off = style;
}
self
}
fn opt_style_hide(mut self, style: Option<Style>) -> TuiLoggerTargetWidget<'b> {
if let Some(s) = style {
self.style_hide = s;
}
self
}
fn opt_style_show(mut self, style: Option<Style>) -> TuiLoggerTargetWidget<'b> {
if let Some(s) = style {
self.style_show = s;
}
self
}
fn opt_highlight_style(mut self, style: Option<Style>) -> TuiLoggerTargetWidget<'b> {
if let Some(s) = style {
self.highlight_style = s;
}
self
}
pub fn style(mut self, style: Style) -> TuiLoggerTargetWidget<'b> {
self.style = style;
self
}
pub fn style_off(mut self, style: Style) -> TuiLoggerTargetWidget<'b> {
self.style_off = Some(style);
self
}
pub fn style_hide(mut self, style: Style) -> TuiLoggerTargetWidget<'b> {
self.style_hide = style;
self
}
pub fn style_show(mut self, style: Style) -> TuiLoggerTargetWidget<'b> {
self.style_show = style;
self
}
pub fn highlight_style(mut self, style: Style) -> TuiLoggerTargetWidget<'b> {
self.highlight_style = style;
self
}
fn inner_state(mut self, state: Arc<Mutex<TuiWidgetInnerState>>) -> TuiLoggerTargetWidget<'b> {
self.state = state;
self
}
pub fn state(mut self, state: &TuiWidgetState) -> TuiLoggerTargetWidget<'b> {
self.state = state.inner.clone();
self
}
}
impl<'b> Widget for TuiLoggerTargetWidget<'b> {
fn render(mut self, area: Rect, buf: &mut Buffer) {
buf.set_style(area, self.style);
let list_area = match self.block.take() {
Some(b) => {
let inner_area = b.inner(area);
b.render(area, buf);
inner_area
}
None => area,
};
if list_area.width < 8 || list_area.height < 1 {
return;
}
let la_left = list_area.left();
let la_top = list_area.top();
let la_width = list_area.width as usize;
{
let hot_targets = &TUI_LOGGER.inner.lock().targets;
let mut state = self.state.lock();
let hide_off = state.hide_off;
let offset = state.offset;
let focus_selected = state.focus_selected;
{
let targets = &mut state.config;
targets.merge(hot_targets);
self.targets.clear();
for (t, levelfilter) in targets.iter() {
if hide_off && levelfilter == &LevelFilter::Off {
continue;
}
self.targets.push(t.clone());
}
self.targets.sort();
}
state.nr_items = self.targets.len();
if state.selected >= state.nr_items {
state.selected = state.nr_items.max(1) - 1;
}
if state.selected < state.nr_items {
state.opt_selected_target = Some(self.targets[state.selected].clone());
let t = &self.targets[state.selected];
let (more, less) = if let Some(levelfilter) = state.config.get(t) {
advance_levelfilter(levelfilter)
} else {
(None, None)
};
state.opt_selected_visibility_less = less;
state.opt_selected_visibility_more = more;
let (more, less) = if let Some(levelfilter) = hot_targets.get(t) {
advance_levelfilter(levelfilter)
} else {
(None, None)
};
state.opt_selected_recording_less = less;
state.opt_selected_recording_more = more;
}
let list_height = (list_area.height as usize).min(self.targets.len());
let offset = if list_height > self.targets.len() {
0
} else if state.selected < state.nr_items {
let sel = state.selected;
if sel >= offset + list_height {
// selected is below visible list range => make it the bottom
sel - list_height + 1
} else if sel.min(offset) + list_height > self.targets.len() {
self.targets.len() - list_height
} else {
sel.min(offset)
}
} else {
0
};
state.offset = offset;
let targets = &(&state.config);
for i in 0..list_height {
let t = &self.targets[i + offset];
let hot_level_filter = hot_targets.get(&t).unwrap();
let level_filter = targets.get(&t).unwrap();
for (j, sym, lev) in &[
(0, "E", Level::Error),
(1, "W", Level::Warn),
(2, "I", Level::Info),
(3, "D", Level::Debug),
(4, "T", Level::Trace),
] {
let mut cell = buf.get_mut(la_left + j, la_top + i as u16);
let cell_style = if *hot_level_filter >= *lev {
if *level_filter >= *lev {
if !focus_selected || i + offset == state.selected {
self.style_show
} else {
self.style_hide
}
} else {
self.style_hide
}
} else if let Some(style_off) = self.style_off {
style_off
} else {
cell.symbol = " ".to_string();
continue;
};
cell.set_style(cell_style);
cell.symbol = sym.to_string();
}
buf.set_stringn(la_left + 5, la_top + i as u16, &":", la_width, self.style);
buf.set_stringn(
la_left + 6,
la_top + i as u16,
t,
la_width,
if i + offset == state.selected {
self.highlight_style
} else {
self.style
},
);
}
}
}
}
/// The TuiLoggerWidget shows the logging messages in an endless scrolling view.
/// It is controlled by a TuiWidgetState for selected events.
pub struct TuiLoggerWidget<'b> {
block: Option<Block<'b>>,
/// Base style of the widget
style: Style,
/// Level based style
style_error: Option<Style>,
style_warn: Option<Style>,
style_debug: Option<Style>,
style_trace: Option<Style>,
style_info: Option<Style>,
state: Arc<Mutex<TuiWidgetInnerState>>,
}
impl<'b> Default for TuiLoggerWidget<'b> {
fn default() -> TuiLoggerWidget<'b> {
TUI_LOGGER.move_events();
TuiLoggerWidget {
block: None,
style: Default::default(),
style_error: None,
style_warn: None,
style_debug: None,
style_trace: None,
style_info: None,
state: Arc::new(Mutex::new(TuiWidgetInnerState::new())),
}
}
}
impl<'b> TuiLoggerWidget<'b> {
pub fn block(mut self, block: Block<'b>) -> TuiLoggerWidget<'b> {
self.block = Some(block);
self
}
fn opt_style(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if let Some(s) = style {
self.style = s;
}
self
}
fn opt_style_error(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if style.is_some() {
self.style_error = style;
}
self
}
fn opt_style_warn(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if style.is_some() {
self.style_warn = style;
}
self
}
fn opt_style_info(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if style.is_some() {
self.style_info = style;
}
self
}
fn opt_style_trace(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if style.is_some() {
self.style_trace = style;
}
self
}
fn opt_style_debug(mut self, style: Option<Style>) -> TuiLoggerWidget<'b> {
if style.is_some() {
self.style_debug = style;
}
self
}
pub fn style(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style = style;
self
}
pub fn style_error(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style_error = Some(style);
self
}
pub fn style_warn(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style_warn = Some(style);
self
}
pub fn style_info(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style_info = Some(style);
self
}
pub fn style_trace(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style_trace = Some(style);
self
}
pub fn style_debug(mut self, style: Style) -> TuiLoggerWidget<'b> {
self.style_debug = Some(style);
self
}
fn inner_state(mut self, state: Arc<Mutex<TuiWidgetInnerState>>) -> TuiLoggerWidget<'b> {
self.state = state;
self
}
pub fn state(&mut self, state: &TuiWidgetState) -> &mut TuiLoggerWidget<'b> {
self.state = state.inner.clone();
self
}
}
impl<'b> Widget for TuiLoggerWidget<'b> {
fn render(mut self, area: Rect, buf: &mut Buffer) {
buf.set_style(area, self.style);
let list_area = match self.block.take() {
Some(b) => {
let inner_area = b.inner(area);
b.render(area, buf);
inner_area
}
None => area,
};
if list_area.width < 8 || list_area.height < 1 {
return;
}
let mut state = self.state.lock();
let la_height = list_area.height as usize;
let mut lines: Vec<(Option<Style>, u16, String)> = vec![];
let indent = 9;
{
state.opt_timestamp_next_page = None;
let opt_timestamp_bottom = state.opt_timestamp_bottom;
let mut opt_timestamp_prev_page = None;
let mut tui_lock = TUI_LOGGER.inner.lock();
let mut circular = CircularBuffer::new(10); // MAGIC constant
for evt in tui_lock.events.rev_iter() {
if let Some(level) = state.config.get(&evt.target) {
if *level < evt.level {
continue;
}
}
if state.focus_selected {
if let Some(target) = state.opt_selected_target.as_ref() {
if target != &evt.target {
continue;
}
}
}
// Here all filters have been applied,
// So check, if user is paging through history
if let Some(timestamp) = opt_timestamp_bottom.as_ref() {
if *timestamp < evt.timestamp {
circular.push(evt.timestamp);
continue;
}
}
if !circular.is_empty() {
state.opt_timestamp_next_page = circular.take().first().cloned();
}
let mut output = String::new();
output.push_str(&format!("{}", evt.timestamp.format("%H:%M:%S")));
output.push(':');
let (col_style, txt, with_loc) = match evt.level {
log::Level::Error => (self.style_error, "ERROR", true),
log::Level::Warn => (self.style_warn, "WARN ", true),
log::Level::Info => (self.style_info, "INFO ", false),
log::Level::Debug => (self.style_debug, "DEBUG", true),
log::Level::Trace => (self.style_trace, "TRACE", true),
};
output.push_str(txt);
output.push(':');
output.push_str(&evt.target);
if with_loc {
output.push(':');
output.push_str(&evt.file);
output.push(':');
output.push_str(&format!("{}", evt.line));
}
output.push(':');
let mut sublines: Vec<&str> = evt.msg.lines().rev().collect();
output.push_str(sublines.pop().unwrap());
for subline in sublines {
lines.push((col_style, indent, subline.to_string()));
}
lines.push((col_style, 0, output));
if lines.len() == la_height {
break;
}
if opt_timestamp_prev_page.is_none() && lines.len() >= la_height / 2 {
opt_timestamp_prev_page = Some(evt.timestamp);
}
}
state.opt_timestamp_prev_page = opt_timestamp_prev_page.or(state.opt_timestamp_bottom);
}
let la_left = list_area.left();
let la_top = list_area.top();
let la_width = list_area.width as usize;
// lines is a vector with bottom line at index 0
// wrapped_lines will be a vector with top line first
let mut wrapped_lines = CircularBuffer::new(la_height);
while let Some((style, left, line)) = lines.pop() {
if line.chars().count() > la_width {
wrapped_lines.push((style, left, line.chars().take(la_width).collect()));
let mut remain: String = line.chars().skip(la_width).collect();
let rem_width = la_width - indent as usize;
while remain.chars().count() > rem_width {
let remove: String = remain.chars().take(rem_width).collect();
wrapped_lines.push((style, indent, remove));
remain = remain.chars().skip(rem_width).collect();
}
wrapped_lines.push((style, indent, remain.to_owned()));
} else {
wrapped_lines.push((style, left, line));
}
}
let offset: u16 = if state.opt_timestamp_bottom.is_none() {
0
} else {
let lines_cnt = wrapped_lines.len();
(la_height - lines_cnt) as u16
};
for (i, (sty, left, l)) in wrapped_lines.iter().enumerate() {
buf.set_stringn(
la_left + left,
la_top + i as u16 + offset,
l,
l.len(),
sty.unwrap_or(self.style),
);
}
}
}
/// The Smart Widget combines the TuiLoggerWidget and the TuiLoggerTargetWidget
/// into a nice combo, where the TuiLoggerTargetWidget can be shown/hidden.
///
/// In the title the number of logging messages/s in the whole buffer is shown.
pub struct TuiLoggerSmartWidget<'a> {
title_log: Spans<'a>,
title_target: Spans<'a>,
style: Option<Style>,
border_style: Style,
highlight_style: Option<Style>,
style_error: Option<Style>,
style_warn: Option<Style>,
style_debug: Option<Style>,
style_trace: Option<Style>,
style_info: Option<Style>,
style_show: Option<Style>,