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
//! Simple logger, it writes in file and in console at the same time.
use crate::lazy_static::lazy_static;
use crate::parking_lot::Mutex;
use std::fmt::{Debug, Display};
use crate::instant::Instant;
#[cfg(not(target_arch = "wasm32"))]
use std::io::{self, Write};
use std::sync::mpsc::Sender;
use std::time::Duration;
#[cfg(target_arch = "wasm32")]
use crate::wasm_bindgen::{self, prelude::*};
#[cfg(target_arch = "wasm32")]
#[wasm_bindgen]
extern "C" {
// Use `js_namespace` here to bind `console.log(..)` instead of just
// `log(..)`
#[wasm_bindgen(js_namespace = console)]
fn log(s: &str);
}
/// A message that could be sent by the logger to all listeners.
pub struct LogMessage {
/// Kind of the message: information, warning or error.
pub kind: MessageKind,
/// The source message without logger prefixes.
pub content: String,
/// Time point at which the message was recorded. It is relative to the moment when the
/// logger was initialized.
pub time: Duration,
}
lazy_static! {
static ref LOG: Mutex<Log> = Mutex::new(Log {
#[cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))]
file: std::fs::File::create("fyrox.log").unwrap(),
verbosity: MessageKind::Information,
listeners: Default::default(),
time_origin: Instant::now()
});
}
/// A kind of message.
#[derive(Copy, Clone, PartialOrd, PartialEq, Eq, Ord, Hash)]
#[repr(u32)]
pub enum MessageKind {
/// Some useful information.
Information = 0,
/// A warning.
Warning = 1,
/// An error of some kind.
Error = 2,
}
impl MessageKind {
fn as_str(self) -> &'static str {
match self {
MessageKind::Information => "[INFO]: ",
MessageKind::Warning => "[WARNING]: ",
MessageKind::Error => "[ERROR]: ",
}
}
}
/// See module docs.
pub struct Log {
#[cfg(all(not(target_arch = "wasm32"), not(target_os = "android")))]
file: std::fs::File,
verbosity: MessageKind,
listeners: Vec<Sender<LogMessage>>,
time_origin: Instant,
}
impl Log {
fn write_internal<S>(&mut self, kind: MessageKind, message: S)
where
S: AsRef<str>,
{
let mut msg = message.as_ref().to_owned();
if kind as u32 >= self.verbosity as u32 {
// Notify listeners about the message and remove all disconnected listeners.
self.listeners.retain(|listener| {
listener
.send(LogMessage {
kind,
content: msg.clone(),
time: Instant::now() - self.time_origin,
})
.is_ok()
});
msg.insert_str(0, kind.as_str());
#[cfg(target_arch = "wasm32")]
{
log(&msg);
}
#[cfg(all(not(target_os = "android"), not(target_arch = "wasm32")))]
{
let _ = io::stdout().write_all(msg.as_bytes());
let _ = self.file.write_all(msg.as_bytes());
}
#[cfg(target_os = "android")]
{
let _ = io::stdout().write_all(msg.as_bytes());
}
}
}
fn writeln_internal<S>(&mut self, kind: MessageKind, message: S)
where
S: AsRef<str>,
{
let mut msg = message.as_ref().to_owned();
msg.push('\n');
self.write_internal(kind, msg)
}
/// Writes string into console and into file.
pub fn write<S>(kind: MessageKind, msg: S)
where
S: AsRef<str>,
{
LOG.lock().write_internal(kind, msg);
}
/// Writes line into console and into file.
pub fn writeln<S>(kind: MessageKind, msg: S)
where
S: AsRef<str>,
{
LOG.lock().writeln_internal(kind, msg);
}
/// Writes information message.
pub fn info<S>(msg: S)
where
S: AsRef<str>,
{
Self::writeln(MessageKind::Information, msg)
}
/// Writes warning message.
pub fn warn<S>(msg: S)
where
S: AsRef<str>,
{
Self::writeln(MessageKind::Warning, msg)
}
/// Writes error message.
pub fn err<S>(msg: S)
where
S: AsRef<str>,
{
Self::writeln(MessageKind::Error, msg)
}
/// Sets verbosity level.
pub fn set_verbosity(kind: MessageKind) {
LOG.lock().verbosity = kind;
}
/// Adds a listener that will receive a copy of every message passed into the log.
pub fn add_listener(listener: Sender<LogMessage>) {
LOG.lock().listeners.push(listener)
}
/// Allows you to verify that the result of operation is Ok, or print the error in the log.
///
/// # Use cases
///
/// Typical use case for this method is that when you _can_ ignore errors, but want them to
/// be in the log.
pub fn verify<T, E>(result: Result<T, E>)
where
E: Debug,
{
if let Err(e) = result {
Self::writeln(
MessageKind::Error,
format!("Operation failed! Reason: {:?}", e),
);
}
}
/// Allows you to verify that the result of operation is Ok, or print the error in the log.
///
/// # Use cases
///
/// Typical use case for this method is that when you _can_ ignore errors, but want them to
/// be in the log.
pub fn verify_message<S, T, E>(result: Result<T, E>, msg: S)
where
E: Debug,
S: Display,
{
if let Err(e) = result {
Self::writeln(MessageKind::Error, format!("{}. Reason: {:?}", msg, e));
}
}
}