a371ee3019
# Objective - Contributes to #11478 ## Solution - Made `bevy_utils::tracing` `doc(hidden)` - Re-exported `tracing` from `bevy_log` for end-users - Added `tracing` directly to crates that need it. ## Testing - CI --- ## Migration Guide If you were importing `tracing` via `bevy::utils::tracing`, instead use `bevy::log::tracing`. Note that many items within `tracing` are also directly re-exported from `bevy::log` as well, so you may only need `bevy::log` for the most common items (e.g., `warn!`, `trace!`, etc.). This also applies to the `log_once!` family of macros. ## Notes - While this doesn't reduce the line-count in `bevy_utils`, it further decouples the internal crates from `bevy_utils`, making its eventual removal more feasible in the future. - I have just imported `tracing` as we do for all dependencies. However, a workspace dependency may be more appropriate for version management.
100 lines
3.1 KiB
Rust
100 lines
3.1 KiB
Rust
use alloc::ffi::CString;
|
|
use core::fmt::{Debug, Write};
|
|
use tracing::{
|
|
field::Field,
|
|
span::{Attributes, Record},
|
|
Event, Id, Level, Subscriber,
|
|
};
|
|
use tracing_subscriber::{field::Visit, layer::Context, registry::LookupSpan, Layer};
|
|
|
|
#[derive(Default)]
|
|
pub(crate) struct AndroidLayer;
|
|
|
|
struct StringRecorder(String, bool);
|
|
impl StringRecorder {
|
|
fn new() -> Self {
|
|
StringRecorder(String::new(), false)
|
|
}
|
|
}
|
|
|
|
impl Visit for StringRecorder {
|
|
fn record_debug(&mut self, field: &Field, value: &dyn Debug) {
|
|
if field.name() == "message" {
|
|
if !self.0.is_empty() {
|
|
self.0 = format!("{:?}\n{}", value, self.0)
|
|
} else {
|
|
self.0 = format!("{:?}", value)
|
|
}
|
|
} else {
|
|
if self.1 {
|
|
// following args
|
|
write!(self.0, " ").unwrap();
|
|
} else {
|
|
// first arg
|
|
self.1 = true;
|
|
}
|
|
write!(self.0, "{} = {:?};", field.name(), value).unwrap();
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Default for StringRecorder {
|
|
fn default() -> Self {
|
|
StringRecorder::new()
|
|
}
|
|
}
|
|
|
|
impl<S: Subscriber + for<'a> LookupSpan<'a>> Layer<S> for AndroidLayer {
|
|
fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
|
|
let mut new_debug_record = StringRecorder::new();
|
|
attrs.record(&mut new_debug_record);
|
|
|
|
if let Some(span_ref) = ctx.span(id) {
|
|
span_ref
|
|
.extensions_mut()
|
|
.insert::<StringRecorder>(new_debug_record);
|
|
}
|
|
}
|
|
|
|
fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>) {
|
|
if let Some(span_ref) = ctx.span(id) {
|
|
if let Some(debug_record) = span_ref.extensions_mut().get_mut::<StringRecorder>() {
|
|
values.record(debug_record);
|
|
}
|
|
}
|
|
}
|
|
|
|
#[allow(unsafe_code)]
|
|
fn on_event(&self, event: &Event<'_>, _ctx: Context<'_, S>) {
|
|
fn sanitize(string: &str) -> CString {
|
|
let bytes: Vec<u8> = string
|
|
.as_bytes()
|
|
.into_iter()
|
|
.copied()
|
|
.filter(|byte| *byte != 0)
|
|
.collect();
|
|
CString::new(bytes).unwrap()
|
|
}
|
|
|
|
let mut recorder = StringRecorder::new();
|
|
event.record(&mut recorder);
|
|
let meta = event.metadata();
|
|
let priority = match *meta.level() {
|
|
Level::TRACE => android_log_sys::LogPriority::VERBOSE,
|
|
Level::DEBUG => android_log_sys::LogPriority::DEBUG,
|
|
Level::INFO => android_log_sys::LogPriority::INFO,
|
|
Level::WARN => android_log_sys::LogPriority::WARN,
|
|
Level::ERROR => android_log_sys::LogPriority::ERROR,
|
|
};
|
|
// SAFETY: Called only on Android platforms. priority is guaranteed to be in range of c_int.
|
|
// The provided tag and message are null terminated properly.
|
|
unsafe {
|
|
android_log_sys::__android_log_write(
|
|
priority as android_log_sys::c_int,
|
|
sanitize(meta.name()).as_ptr(),
|
|
sanitize(&recorder.0).as_ptr(),
|
|
);
|
|
}
|
|
}
|
|
}
|