msime_engine/
logging.rs

1//! 引擎的日志出口。引擎只在自己兜住了的异常上记一行（日志不是数据库被挪开、反查索引建不了、下载的五笔码表并不进代次、辅助码表读不到），每一行都是警告，不影响调用结果。
2//!
3//! 缺省写到标准错误，前面加 `msime: `，和以前直接 `eprintln!` 的输出逐字节相同。嵌入引擎的程序用 [`set_log_sink`] 换成自己的出口（宿主日志、C ABI 的回调）；引擎的非测试代码不直接写标准错误，`lib.rs` 用 `clippy::print_stderr` 拦住。
4
5use std::fmt;
6use std::sync::{Arc, PoisonError, RwLock};
7
8/// 接收一行日志（不带 `msime: ` 前缀和换行）。可能在任何线程上被调用，要自己处理并发；不要在里面再调引擎。
9pub type LogSink = Arc<dyn Fn(&str) + Send + Sync>;
10
11static SINK: RwLock<Option<LogSink>> = RwLock::new(None);
12
13/// 换掉进程级的日志出口；`None` 回到缺省的标准错误。之后记的每一行都交给新的出口。
14pub fn set_log_sink(sink: Option<LogSink>) {
15    *SINK.write().unwrap_or_else(PoisonError::into_inner) = sink;
16}
17
18/// 记一行警告。出口在锁外调用，出口里再换出口也不会死锁。
19#[allow(clippy::print_stderr)]
20pub(crate) fn warn(message: fmt::Arguments<'_>) {
21    let sink = SINK.read().unwrap_or_else(PoisonError::into_inner).clone();
22    match sink {
23        Some(sink) => sink(&message.to_string()),
24        None => eprintln!("msime: {message}"),
25    }
26}
27
28#[cfg(test)]
29mod tests {
30    use std::sync::Mutex;
31
32    use super::*;
33
34    /// 换上的出口收到不带前缀的整行；换回 None 后不再收到。只有这一个测试换出口，其他测试并行记的日志可能也会落进来，所以只找自己那一行。
35    #[test]
36    fn an_installed_sink_receives_lines_until_it_is_removed() {
37        let lines = Arc::new(Mutex::new(Vec::<String>::new()));
38        let captured = Arc::clone(&lines);
39        set_log_sink(Some(Arc::new(move |line: &str| {
40            captured.lock().unwrap().push(line.to_owned());
41        })));
42        warn(format_args!("synthetic log line {}", 1));
43        set_log_sink(None);
44        warn(format_args!("synthetic log line {}", 2));
45        let lines = lines.lock().unwrap();
46        assert!(lines.iter().any(|line| line == "synthetic log line 1"));
47        assert!(!lines.iter().any(|line| line == "synthetic log line 2"));
48    }
49}
msime_engine/logging.rs

msime_engine/
logging.rs
