|
| 1 | +// Copyright 2020, The Gtk-rs Project Developers. |
| 2 | +// See the COPYRIGHT file at the top-level directory of this distribution. |
| 3 | +// Licensed under the MIT license, see the LICENSE file or <http://opensource.org/licenses/MIT> |
| 4 | + |
| 5 | +extern crate log as rs_log; |
| 6 | + |
| 7 | +use glib_sys; |
| 8 | +use translate::*; |
| 9 | + |
| 10 | +/// Enumeration of the possible formatting behaviours for a |
| 11 | +/// [`GlibLogger`](struct.GlibLogger.html). |
| 12 | +/// |
| 13 | +/// In order to use this type, `glib` must be built with the `log` feature |
| 14 | +/// enabled. |
| 15 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 16 | +pub enum GlibLoggerFormat { |
| 17 | + /// A simple format, writing only the message on output. |
| 18 | + Plain, |
| 19 | + /// A simple format, writing file, line and message on output. |
| 20 | + LineAndFile, |
| 21 | + /// A logger using glib structured logging. Structured logging is available |
| 22 | + /// only on features `v2_56` and later. |
| 23 | + #[cfg(any(feature = "v2_56", feature = "dox"))] |
| 24 | + Structured, |
| 25 | +} |
| 26 | + |
| 27 | +/// Enumeration of the possible domain handling behaviours for a |
| 28 | +/// [`GlibLogger`](struct.GlibLogger.html). |
| 29 | +/// |
| 30 | +/// In order to use this type, `glib` must be built with the `log` feature |
| 31 | +/// enabled. |
| 32 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 33 | +pub enum GlibLoggerDomain { |
| 34 | + /// Logs will have no domain specified. |
| 35 | + None, |
| 36 | + /// Logs will use the `target` of the log crate as a domain; this allows |
| 37 | + /// Rust code like `warn!(target: "my-domain", "...");` to log to the glib |
| 38 | + /// logger using the specified domain. |
| 39 | + CrateTarget, |
| 40 | + /// Logs will use the crate path as the log domain. |
| 41 | + CratePath, |
| 42 | +} |
| 43 | + |
| 44 | +/// An implementation of a [`log`](https://crates.io/crates/log) compatible |
| 45 | +/// logger which logs over glib logging facilities. |
| 46 | +/// |
| 47 | +/// In order to use this type, `glib` must be built with the `log` feature |
| 48 | +/// enabled. |
| 49 | +/// |
| 50 | +/// Example: |
| 51 | +/// |
| 52 | +/// ```no_run |
| 53 | +/// extern crate log; |
| 54 | +/// |
| 55 | +/// static glib_logger: glib::GlibLogger = glib::GlibLogger::new( |
| 56 | +/// glib::GlibLoggerFormat::Plain, |
| 57 | +/// glib::GlibLoggerDomain::CrateTarget, |
| 58 | +/// ); |
| 59 | +/// |
| 60 | +/// log::set_logger(&glib_logger); |
| 61 | +/// log::set_max_level(log::LevelFilter::Debug); |
| 62 | +/// |
| 63 | +/// log::info!("This line will get logged by glib"); |
| 64 | +/// ``` |
| 65 | +#[derive(Debug)] |
| 66 | +pub struct GlibLogger { |
| 67 | + format: GlibLoggerFormat, |
| 68 | + domain: GlibLoggerDomain, |
| 69 | +} |
| 70 | + |
| 71 | +impl GlibLogger { |
| 72 | + /// Creates a new instance of [`GlibLogger`](struct.GlibLogger.html). |
| 73 | + /// |
| 74 | + /// Example: |
| 75 | + /// |
| 76 | + /// ```no_run |
| 77 | + /// extern crate log; |
| 78 | + /// |
| 79 | + /// static glib_logger: glib::GlibLogger = glib::GlibLogger::new( |
| 80 | + /// glib::GlibLoggerFormat::Plain, |
| 81 | + /// glib::GlibLoggerDomain::CrateTarget, |
| 82 | + /// ); |
| 83 | + /// |
| 84 | + /// log::set_logger(&glib_logger); |
| 85 | + /// log::set_max_level(log::LevelFilter::Debug); |
| 86 | + /// |
| 87 | + /// log::info!("This line will get logged by glib"); |
| 88 | + /// ``` |
| 89 | + pub const fn new(format: GlibLoggerFormat, domain: GlibLoggerDomain) -> Self { |
| 90 | + GlibLogger { format, domain } |
| 91 | + } |
| 92 | + |
| 93 | + fn level_to_glib(level: rs_log::Level) -> glib_sys::GLogLevelFlags { |
| 94 | + match level { |
| 95 | + // Errors are mapped to critical to avoid automatic termination |
| 96 | + rs_log::Level::Error => glib_sys::G_LOG_LEVEL_CRITICAL, |
| 97 | + rs_log::Level::Warn => glib_sys::G_LOG_LEVEL_WARNING, |
| 98 | + rs_log::Level::Info => glib_sys::G_LOG_LEVEL_INFO, |
| 99 | + rs_log::Level::Debug => glib_sys::G_LOG_LEVEL_DEBUG, |
| 100 | + // There is no equivalent to trace level in glib |
| 101 | + rs_log::Level::Trace => glib_sys::G_LOG_LEVEL_DEBUG, |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + fn write_log(domain: Option<&str>, level: rs_log::Level, message: &str) { |
| 106 | + unsafe { |
| 107 | + crate::glib_sys::g_log( |
| 108 | + domain.to_glib_none().0, |
| 109 | + GlibLogger::level_to_glib(level), |
| 110 | + message.replace("%", "%%").to_glib_none().0, |
| 111 | + ); |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + #[cfg(any(feature = "v2_56", feature = "dox"))] |
| 116 | + fn write_log_structured( |
| 117 | + domain: Option<&str>, |
| 118 | + level: log::Level, |
| 119 | + file: Option<&str>, |
| 120 | + line: Option<u32>, |
| 121 | + func: Option<&str>, |
| 122 | + message: &str, |
| 123 | + ) { |
| 124 | + let line_str = match line { |
| 125 | + None => None, |
| 126 | + Some(l) => Some(l.to_string()), |
| 127 | + }; |
| 128 | + |
| 129 | + unsafe { |
| 130 | + crate::glib_sys::g_log_structured_standard( |
| 131 | + domain.to_glib_none().0, |
| 132 | + GlibLogger::level_to_glib(level), |
| 133 | + file.to_glib_none().0, |
| 134 | + line_str.to_glib_none().0, |
| 135 | + func.to_glib_none().0, |
| 136 | + message.replace("%", "%%").to_glib_none().0, |
| 137 | + ); |
| 138 | + } |
| 139 | + } |
| 140 | +} |
| 141 | + |
| 142 | +impl rs_log::Log for GlibLogger { |
| 143 | + fn enabled(&self, _: &rs_log::Metadata) -> bool { |
| 144 | + true |
| 145 | + } |
| 146 | + |
| 147 | + fn log(&self, record: &rs_log::Record) { |
| 148 | + if !self.enabled(record.metadata()) { |
| 149 | + return; |
| 150 | + } |
| 151 | + |
| 152 | + let domain = match &self.domain { |
| 153 | + GlibLoggerDomain::None => None, |
| 154 | + GlibLoggerDomain::CrateTarget => Some(record.metadata().target()), |
| 155 | + GlibLoggerDomain::CratePath => record.module_path(), |
| 156 | + }; |
| 157 | + |
| 158 | + match self.format { |
| 159 | + GlibLoggerFormat::Plain => { |
| 160 | + let s = format!("{}", record.args()); |
| 161 | + GlibLogger::write_log(domain, record.level(), &s) |
| 162 | + } |
| 163 | + GlibLoggerFormat::LineAndFile => { |
| 164 | + let s = match (record.file(), record.line()) { |
| 165 | + (Some(file), Some(line)) => format!("{}:{}: {}", file, line, record.args()), |
| 166 | + (Some(file), None) => format!("{}: {}", file, record.args()), |
| 167 | + _ => format!("{}", record.args()), |
| 168 | + }; |
| 169 | + |
| 170 | + GlibLogger::write_log(domain, record.level(), &s); |
| 171 | + } |
| 172 | + #[cfg(any(feature = "v2_56", feature = "dox"))] |
| 173 | + GlibLoggerFormat::Structured => { |
| 174 | + GlibLogger::write_log_structured( |
| 175 | + domain, |
| 176 | + record.level(), |
| 177 | + record.file(), |
| 178 | + record.line(), |
| 179 | + None, |
| 180 | + &format!("{}", record.args()), |
| 181 | + ); |
| 182 | + } |
| 183 | + }; |
| 184 | + } |
| 185 | + |
| 186 | + fn flush(&self) {} |
| 187 | +} |
0 commit comments