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
//! # A `FlexiLoggerView` for cursive
//!
//! This crate provides a new debug view for
//! [gyscos/cursive](https://github.com/gyscos/cursive) using the
//! [emabee/flexi_logger](https://github.com/emabee/flexi_logger) crate. This
//! enables the `FlexiLoggerView` to respect the `RUST_LOG` environment variable
//! as well as the `flexi_logger` configuration file. Have a look at the `demo`
//! below to see how it looks.
//!
//! ## Using the `FlexiLoggerView`
//!
//! To create a `FlexiLoggerView` you first have to register the
//! `cursive_flexi_logger` as a `LogTarget` in `flexi_logger`. After the
//! `flexi_logger` has started, you may create a `FlexiLoggerView` instance and
//! add it to cursive.
//!
//! ```rust
//! use cursive::{Cursive, CursiveExt};
//! use cursive_flexi_logger_view::FlexiLoggerView;
//! use flexi_logger::Logger;
//!
//! fn main() {
//! // we need to initialize cursive first, as the cursive-flexi-logger
//! // needs a cursive callback sink to notify cursive about screen refreshs
//! // when a new log message arrives
//! let mut siv = Cursive::default();
//!
//! Logger::try_with_env_or_str("trace")
//! .expect("Could not create Logger from environment :(")
//! .log_to_file_and_writer(
//! flexi_logger::FileSpec::default()
//! .directory("logs")
//! .suppress_timestamp(),
//! cursive_flexi_logger_view::cursive_flexi_logger(&siv)
//! )
//! .format(flexi_logger::colored_with_thread)
//! .start()
//! .expect("failed to initialize logger!");
//!
//! siv.add_layer(FlexiLoggerView::scrollable()); // omit `scrollable` to remove scrollbars
//!
//! log::info!("test log message");
//! // siv.run();
//! }
//! ```
//!
//! Look into the `FlexiLoggerView` documentation for a detailed explanation.
//!
//! ## Add toggleable flexi_logger debug console view
//!
//! This crate also provide utility functions, which is simplify usage of `FlexiLoggerView`, providing
//! debug console view like [`Cursive::toggle_debug_console`](/cursive/latest/cursive/struct.Cursive.html#method.toggle_debug_console).
//! There is 3 functions:
//!
//! - `show_flexi_logger_debug_console`: show debug console view;
//! - `hide_flexi_logger_debug_console`: hide debug console view (if visible);
//! - `toggle_flexi_logger_debug_console`: show the debug console view, or hide it if it's already visible.
//!
//! ```rust
//! use cursive::{Cursive, CursiveExt};
//! use cursive_flexi_logger_view::{show_flexi_logger_debug_console, hide_flexi_logger_debug_console, toggle_flexi_logger_debug_console};
//! use flexi_logger::Logger;
//!
//! fn main() {
//! // we need to initialize cursive first, as the cursive-flexi-logger
//! // needs a cursive callback sink to notify cursive about screen refreshs
//! // when a new log message arrives
//! let mut siv = Cursive::default();
//!
//! Logger::try_with_env_or_str("trace")
//! .expect("Could not create Logger from environment :(")
//! .log_to_file_and_writer(
//! flexi_logger::FileSpec::default()
//! .directory("logs")
//! .suppress_timestamp(),
//! cursive_flexi_logger_view::cursive_flexi_logger(&siv)
//! )
//! .format(flexi_logger::colored_with_thread)
//! .start()
//! .expect("failed to initialize logger!");
//!
//! siv.add_global_callback('~', toggle_flexi_logger_debug_console); // Bind '~' key to show/hide debug console view
//! siv.add_global_callback('s', show_flexi_logger_debug_console); // Bind 's' key to show debug console view
//! siv.add_global_callback('h', hide_flexi_logger_debug_console); // Bind 'h' key to hide debug console view
//!
//! log::info!("test log message");
//! // siv.run();
//! }
//! ```
use arraydeque::{ArrayDeque, Wrapping};
use cursive_core::theme::{BaseColor, Color};
use cursive_core::utils::markup::StyledString;
use cursive_core::view::{Nameable, ScrollStrategy, Scrollable, View};
use cursive_core::views::{Dialog, ScrollView};
use cursive_core::{CbSink, Cursive, Printer, Vec2};
use flexi_logger::{writers::LogWriter, DeferredNow, Level, Record};
use unicode_width::UnicodeWidthStr;
use std::sync::{Arc, Mutex};
use std::thread;
type LogBuffer = ArrayDeque<[StyledString; 2048], Wrapping>;
static FLEXI_LOGGER_DEBUG_VIEW_NAME: &str = "_flexi_debug_view";
lazy_static::lazy_static! {
static ref LOGS: Arc<Mutex<LogBuffer>> = Arc::new(Mutex::new(LogBuffer::new()));
}
/// The `FlexiLoggerView` displays log messages from the `cursive_flexi_logger` log target.
/// It is safe to create multiple instances of this struct.
///
/// # Create a plain `FlexiLoggerView`
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use cursive_flexi_logger_view::FlexiLoggerView;
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
///
/// siv.add_layer(FlexiLoggerView::new()); // add a plain flexi-logger view
///
/// log::info!("test log message");
/// // siv.run();
/// }
/// ```
///
/// # Create a scrollable `FlexiLoggerView`
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use cursive_flexi_logger_view::FlexiLoggerView;
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
///
/// siv.add_layer(FlexiLoggerView::scrollable()); // add a scrollable flexi-logger view
///
/// log::info!("test log message");
/// // siv.run();
/// }
/// ```
pub struct FlexiLoggerView {
pub indent: bool,
}
pub trait Indentable {
fn no_indent(self) -> Self;
fn indent(self) -> Self;
}
impl FlexiLoggerView {
/// Create a new `FlexiLoggerView` which is wrapped in a `ScrollView`.
pub fn scrollable() -> ScrollView<Self> {
FlexiLoggerView { indent: true }
.scrollable()
.scroll_x(true)
.scroll_y(true)
.scroll_strategy(ScrollStrategy::StickToBottom)
}
/// Create a new `FlexiLoggerView`.
pub fn new() -> Self {
FlexiLoggerView { indent: true }
}
}
impl Indentable for ScrollView<FlexiLoggerView> {
/// Changes a `FlexiLoggerView`, which is contained in a `ScrollView`, to not indent messages
/// spanning multiple lines.
fn no_indent(mut self) -> Self {
self.get_inner_mut().indent = false;
self
}
/// Changes a `FlexiLoggerView`, which is contained in a `ScrollView`, to indent messages
/// spanning multiple lines.
fn indent(mut self) -> Self {
self.get_inner_mut().indent = true;
self
}
}
impl Indentable for FlexiLoggerView {
/// Changes a `FlexiLoggerView` to not indent messages spanning multiple lines.
fn no_indent(mut self) -> Self {
self.indent = false;
self
}
/// Changes a `FlexiLoggerView` to indent messages spanning multiple lines.
fn indent(mut self) -> Self {
self.indent = true;
self
}
}
impl View for FlexiLoggerView {
fn draw(&self, printer: &Printer<'_, '_>) {
let logs = LOGS.lock().unwrap();
// Only print the last logs, so skip what doesn't fit
let skipped = logs.len().saturating_sub(printer.size.y);
let mut y = 0;
for msg in logs.iter().skip(skipped) {
let mut x = 0;
// Assume the log message is the last styled span
let log_msg_index = msg.spans_raw().len() - 1;
for span in msg.spans().take(log_msg_index) {
printer.with_style(*span.attr, |printer| {
printer.print((x, y), span.content);
});
x += span.width;
}
let log_msg = msg.spans().skip(log_msg_index).next().unwrap();
for part in log_msg.content.split('\n') {
printer.with_style(*log_msg.attr, |printer| {
printer.print((x, y), part);
});
y += 1;
if !self.indent {
x = 0;
}
// x is not modified ⇒ multiline messages look like this:
// DEBUG <src/main.rs:47> first line
// second line
}
}
}
fn required_size(&mut self, constraint: Vec2) -> Vec2 {
let logs = LOGS.lock().unwrap();
// The longest line sets the width
let w = logs
.iter()
.map(|msg| {
msg.spans()
.map(|x|
// if the log message contains more than one line,
// only the longest line should be considered
// (definitely not the total content.len())
x.content.split('\n').map(|x| x.width()).max().unwrap())
.sum::<usize>()
})
.max()
.unwrap_or(1);
let h = logs
.iter()
.map(|msg| {
msg.spans()
.last()
.map(|x| x.content.split('\n').count())
.unwrap()
})
.sum::<usize>();
let w = std::cmp::max(w, constraint.x);
let h = std::cmp::max(h, constraint.y);
Vec2::new(w, h)
}
}
/// The `flexi_logger` `LogWriter` implementation for the `FlexiLoggerView`.
///
/// Use the `cursive_flexi_logger` function to create an instance of this struct.
pub struct CursiveLogWriter {
sink: CbSink,
}
/// Creates a new `LogWriter` instance for the `FlexiLoggerView`. Use this to
/// register a cursive log writer in `flexi_logger`.
///
/// Although, it is safe to create multiple cursive log writers, it may not be
/// what you want. Each instance of a cursive log writer replicates the log
/// messages in to `FlexiLoggerView`. When registering multiple cursive log
/// writer instances, a single log messages will be duplicated by each log
/// writer.
///
/// # Registering the cursive log writer in `flexi_logger`
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
/// }
/// ```
pub fn cursive_flexi_logger(siv: &Cursive) -> Box<CursiveLogWriter> {
Box::new(CursiveLogWriter {
sink: siv.cb_sink().clone(),
})
}
use time::{format_description::FormatItem, macros::format_description};
const FORMAT: &[FormatItem<'static>] = format_description!("%T%.3f");
impl LogWriter for CursiveLogWriter {
fn write(&self, now: &mut DeferredNow, record: &Record) -> std::io::Result<()> {
let color = Color::Dark(match record.level() {
Level::Trace => BaseColor::Green,
Level::Debug => BaseColor::Cyan,
Level::Info => BaseColor::Blue,
Level::Warn => BaseColor::Yellow,
Level::Error => BaseColor::Red,
});
let mut line = StyledString::new();
line.append_styled(format!("{}", now.format(FORMAT)), color);
line.append_plain(format!(
" [{}] ",
thread::current().name().unwrap_or("(unnamed)"),
));
line.append_styled(format!("{}", record.level()), color);
line.append_plain(format!(
" <{}:{}> ",
record.file().unwrap_or("(unnamed)"),
record.line().unwrap_or(0),
));
line.append_styled(format!("{}", &record.args()), color);
LOGS.lock().unwrap().push_back(line);
self.sink.send(Box::new(|_siv| {})).map_err(|_| {
std::io::Error::new(
std::io::ErrorKind::BrokenPipe,
"cursive callback sink is closed!",
)
})
}
fn flush(&self) -> std::io::Result<()> {
// we are not buffering
Ok(())
}
fn max_log_level(&self) -> log::LevelFilter {
log::LevelFilter::max()
}
}
/// Show the flexi_logger debug console.
///
/// This is analog to [`Cursive::show_debug_console`](/cursive/latest/cursive/struct.Cursive.html#method.show_debug_console).
///
/// # Add binding to show flexi_logger debug view
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use cursive_flexi_logger_view::show_flexi_logger_debug_console;
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
///
/// siv.add_global_callback('~', show_flexi_logger_debug_console); // Add binding to show flexi_logger debug view
///
/// // siv.run();
/// }
/// ```
pub fn show_flexi_logger_debug_console(siv: &mut Cursive) {
siv.add_layer(
Dialog::around(FlexiLoggerView::scrollable().with_name(FLEXI_LOGGER_DEBUG_VIEW_NAME))
.title("Debug console"),
);
}
/// Hide the flexi_logger debug console (if visible).
///
/// # Add binding to hide flexi_logger debug view
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use cursive_flexi_logger_view::hide_flexi_logger_debug_console;
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
///
/// siv.add_global_callback('~', hide_flexi_logger_debug_console); // Add binding to hide flexi_logger debug view
///
/// // siv.run();
/// }
/// ```
pub fn hide_flexi_logger_debug_console(siv: &mut Cursive) {
if let Some(pos) = siv
.screen_mut()
.find_layer_from_name(FLEXI_LOGGER_DEBUG_VIEW_NAME)
{
siv.screen_mut().remove_layer(pos);
}
}
/// Show the flexi_logger debug console, or hide it if it's already visible.
///
/// This is analog to [`Cursive::toggle_debug_console`](/cursive/latest/cursive/struct.Cursive.html#method.toggle_debug_console).
///
/// # Enable toggleable flexi_logger debug view
///
/// ```rust
/// use cursive::{Cursive, CursiveExt};
/// use cursive_flexi_logger_view::toggle_flexi_logger_debug_console;
/// use flexi_logger::Logger;
///
/// fn main() {
/// // we need to initialize cursive first, as the cursive-flexi-logger
/// // needs a cursive callback sink to notify cursive about screen refreshs
/// // when a new log message arrives
/// let mut siv = Cursive::default();
///
/// Logger::try_with_env_or_str("trace")
/// .expect("Could not create Logger from environment :(")
/// .log_to_file_and_writer(
/// flexi_logger::FileSpec::default()
/// .directory("logs")
/// .suppress_timestamp(),
/// cursive_flexi_logger_view::cursive_flexi_logger(&siv)
/// )
/// .format(flexi_logger::colored_with_thread)
/// .start()
/// .expect("failed to initialize logger!");
///
/// siv.add_global_callback('~', toggle_flexi_logger_debug_console); // Enable toggleable flexi_logger debug view
///
/// // siv.run();
/// }
/// ```
pub fn toggle_flexi_logger_debug_console(siv: &mut Cursive) {
if let Some(pos) = siv
.screen_mut()
.find_layer_from_name(FLEXI_LOGGER_DEBUG_VIEW_NAME)
{
siv.screen_mut().remove_layer(pos);
} else {
show_flexi_logger_debug_console(siv);
}
}