diff options
-rw-r--r-- | .cargo_vcs_info.json | 5 | ||||
-rw-r--r-- | .gitignore | 3 | ||||
-rw-r--r-- | .travis.yml | 25 | ||||
-rw-r--r-- | Cargo.toml | 40 | ||||
-rw-r--r-- | Cargo.toml.orig | 32 | ||||
-rw-r--r-- | LICENSE-APACHE | 201 | ||||
-rw-r--r-- | LICENSE-MIT | 19 | ||||
-rw-r--r-- | README.md | 80 | ||||
-rw-r--r-- | src/lib.rs | 408 |
9 files changed, 813 insertions, 0 deletions
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json new file mode 100644 index 0000000..be646cb --- /dev/null +++ b/.cargo_vcs_info.json @@ -0,0 +1,5 @@ +{ + "git": { + "sha1": "3e29144d9b6ef5bf50191bbae0b79affd910bb88" + } +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c7143b --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +target +Cargo.lock +/.idea
\ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..af70373 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,25 @@ +language: rust +rust: + - stable + - beta + - nightly +matrix: + allow_failures: + - rust: nightly +os: + - linux + - osx + +before_script: + - rustup target add arm-linux-androideabi + - rustup target add armv7-linux-androideabi + - rustup target add aarch64-linux-android + - rustup target add i686-linux-android + +script: + - cargo check --target=arm-linux-androideabi + - cargo check --target=armv7-linux-androideabi + - cargo check --target=aarch64-linux-android + - cargo check --target=i686-linux-android + - cargo doc + - cargo test diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..ea060be --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,40 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies +# +# If you believe there's an error in this file please file an +# issue against the rust-lang/cargo repository. If you're +# editing this file be aware that the upstream Cargo.toml +# will likely look very different (and much more reasonable) + +[package] +name = "android_logger" +version = "0.8.6" +authors = ["The android_logger Developers"] +description = "A logging implementation for `log` which hooks to android log output.\n" +readme = "README.md" +keywords = ["android", "bindings", "log", "logger"] +categories = ["api-bindings"] +license = "MIT OR Apache-2.0" +repository = "https://github.com/Nercury/android_logger-rs" +[dependencies.android_log-sys] +version = "0.1" + +[dependencies.env_logger] +version = "0.7" +default-features = false + +[dependencies.lazy_static] +version = "1.0" + +[dependencies.log] +version = "0.4" + +[features] +default = ["regex"] +regex = ["env_logger/regex"] +[badges.travis-ci] +repository = "Nercury/android_logger-rs" diff --git a/Cargo.toml.orig b/Cargo.toml.orig new file mode 100644 index 0000000..753d7f2 --- /dev/null +++ b/Cargo.toml.orig @@ -0,0 +1,32 @@ +[package] +name = "android_logger" +version = "0.8.6" +authors = ["The android_logger Developers"] +license = "MIT OR Apache-2.0" +readme = "README.md" +repository = "https://github.com/Nercury/android_logger-rs" +description = """ +A logging implementation for `log` which hooks to android log output. +""" +keywords = ["android", "bindings", "log", "logger"] +categories = ["api-bindings"] + +[features] +default = ["regex"] +regex = ["env_logger/regex"] + +[dependencies] +lazy_static = "1.0" + +[dependencies.log] +version = "0.4" + +[dependencies.android_log-sys] +version = "0.1" + +[dependencies.env_logger] +version = "0.7" +default-features = false + +[badges] +travis-ci = { repository = "Nercury/android_logger-rs" } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..36b2b45 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +"control" means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity +exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files. + +"Object" form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, "submitted" +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions: + +(a) You must give any other recipients of the Work or +Derivative Works a copy of this License; and + +(b) You must cause any modified files to carry prominent notices +stating that You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works +that You distribute, all copyright, patent, trademark, and +attribution notices from the Source form of the Work, +excluding those notices that do not pertain to any part of +the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its +distribution, then any Derivative Works that You distribute must +include a readable copy of the attribution notices contained +within such NOTICE file, excluding those notices that do not +pertain to any part of the Derivative Works, in at least one +of the following places: within a NOTICE text file distributed +as part of the Derivative Works; within the Source form or +documentation, if provided along with the Derivative Works; or, +within a display generated by the Derivative Works, if and +wherever such third-party notices normally appear. The contents +of the NOTICE file are for informational purposes only and +do not modify the License. You may add Your own attribution +notices within Derivative Works that You distribute, alongside +or as an addendum to the NOTICE text from the Work, provided +that such additional attribution notices cannot be construed +as modifying the License. + +You may add Your own copyright statement to Your modifications and +may provide additional or different license terms and conditions +for use, reproduction, or distribution of Your modifications, or +for any such Derivative Works as a whole, provided Your use, +reproduction, and distribution of the Work otherwise complies with +the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following +boilerplate notice, with the fields enclosed by brackets "{}" +replaced with your own identifying information. (Don't include +the brackets!) The text should be enclosed in the appropriate +comment syntax for the file format. We also recommend that a +file or class name and description of purpose be included on the +same "printed page" as the copyright notice for easier +identification within third-party archives. + +Copyright 2016 The android_logger Developers + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..d73e145 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) 2016 The android_logger Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..43bac67 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +## Send Rust logs to Logcat + +[![Version](https://img.shields.io/crates/v/android_logger.svg)](https://crates.io/crates/android_logger) +[![Build Status](https://travis-ci.org/Nercury/android_logger-rs.svg?branch=master)](https://travis-ci.org/Nercury/android_logger-rs) + +This library is a drop-in replacement for `env_logger`. Instead, it outputs messages to +android's logcat. + +This only works on Android and requires linking to `log` which +is only available under android. With Cargo, it is possible to conditionally require +this library: + +```toml +[target.'cfg(target_os = "android")'.dependencies] +android_logger = "0.8" +``` + +Example of initialization on activity creation, with log configuration: + +```rust +#[macro_use] extern crate log; +extern crate android_logger; + +use log::Level; +use android_logger::{Config,FilterBuilder}; + +fn native_activity_create() { + android_logger::init_once( + Config::default() + .with_min_level(Level::Trace) // limit log level + .with_tag("mytag") // logs will show under mytag tag + .with_filter( // configure messages for specific crate + FilterBuilder::new() + .parse("debug,hello::crate=error") + .build()) + ); + + trace!("this is a verbose {}", "message"); + error!("this is printed by default"); +} +``` + +To allow all logs, use the default configuration with min level Trace: + +```rust +#[macro_use] extern crate log; +extern crate android_logger; + +use log::Level; +use android_logger::Config; + +fn native_activity_create() { + android_logger::init_once( + Config::default().with_min_level(Level::Trace)); +} +``` + +There is a caveat that this library can only be initialized once +(hence the `init_once` function name). However, Android native activity can be +re-created every time the screen is rotated, resulting in multiple initialization calls. +Therefore this library will only log a warning for subsequent `init_once` calls. + +This library ensures that logged messages do not overflow Android log message limits +by efficiently splitting messages into chunks. + +## License + +Licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the Apache-2.0 +license, shall be dual licensed as above, without any additional terms or +conditions. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..ade6b8a --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,408 @@ +// Copyright 2016 The android_logger Developers +// +// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or +// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or +// http://opensource.org/licenses/MIT>, at your option. This file may not be +// copied, modified, or distributed except according to those terms. + +//! A logger which writes to android output. +//! +//! ## Example +//! +//! ``` +//! #[macro_use] extern crate log; +//! extern crate android_logger; +//! +//! use log::Level; +//! use android_logger::Config; +//! +//! /// Android code may not have obvious "main", this is just an example. +//! fn main() { +//! android_logger::init_once( +//! Config::default().with_min_level(Level::Trace), +//! ); +//! +//! debug!("this is a debug {}", "message"); +//! error!("this is printed by default"); +//! } +//! ``` +//! +//! ## Example with module path filter +//! +//! It is possible to limit log messages to output from a specific crate, +//! and override the logcat tag name (by default, the crate name is used): +//! +//! ``` +//! #[macro_use] extern crate log; +//! extern crate android_logger; +//! +//! use log::Level; +//! use android_logger::{Config,FilterBuilder}; +//! +//! fn main() { +//! android_logger::init_once( +//! Config::default() +//! .with_min_level(Level::Trace) +//! .with_tag("mytag") +//! .with_filter(FilterBuilder::new().parse("debug,hello::crate=trace").build()), +//! ); +//! +//! // .. +//! } +//! ``` + +#[cfg(target_os = "android")] +extern crate android_log_sys as log_ffi; +#[macro_use] +extern crate lazy_static; +#[macro_use] +extern crate log; + +extern crate env_logger; + +use std::sync::RwLock; + +#[cfg(target_os = "android")] +use log_ffi::LogPriority; +use log::{Level, Log, Metadata, Record}; +use std::ffi::{CStr, CString}; +use std::mem; +use std::fmt; +use std::ptr; + +pub use env_logger::filter::{Filter, Builder as FilterBuilder}; + +/// Output log to android system. +#[cfg(target_os = "android")] +fn android_log(prio: log_ffi::LogPriority, tag: &CStr, msg: &CStr) { + unsafe { + log_ffi::__android_log_write( + prio as log_ffi::c_int, + tag.as_ptr() as *const log_ffi::c_char, + msg.as_ptr() as *const log_ffi::c_char, + ) + }; +} + +/// Dummy output placeholder for tests. +#[cfg(not(target_os = "android"))] +fn android_log(_priority: Level, _tag: &CStr, _msg: &CStr) {} + +/// Underlying android logger backend +pub struct AndroidLogger { + config: RwLock<Config>, +} + +impl AndroidLogger { + /// Create new logger instance from config + pub fn new(config: Config) -> AndroidLogger { + AndroidLogger { + config: RwLock::new(config), + } + } +} + +lazy_static! { + static ref ANDROID_LOGGER: AndroidLogger = AndroidLogger::default(); +} + +const LOGGING_TAG_MAX_LEN: usize = 23; +const LOGGING_MSG_MAX_LEN: usize = 4000; + +impl Default for AndroidLogger { + /// Create a new logger with default config + fn default() -> AndroidLogger { + AndroidLogger { + config: RwLock::new(Config::default()), + } + } +} + +impl Log for AndroidLogger { + fn enabled(&self, _: &Metadata) -> bool { + true + } + + fn log(&self, record: &Record) { + let config = self.config + .read() + .expect("failed to acquire android_log filter lock for read"); + + if !config.filter_matches(record) { + return; + } + + // tag must not exceed LOGGING_TAG_MAX_LEN + let mut tag_bytes: [u8; LOGGING_TAG_MAX_LEN + 1] = unsafe { mem::uninitialized() }; + + let module_path = record.module_path().unwrap_or_default().to_owned(); + + // If no tag was specified, use module name + let custom_tag = &config.tag; + let tag = custom_tag.as_ref().map(|s| s.as_bytes()).unwrap_or(module_path.as_bytes()); + + // truncate the tag here to fit into LOGGING_TAG_MAX_LEN + self.fill_tag_bytes(&mut tag_bytes, tag); + // use stack array as C string + let tag: &CStr = unsafe { CStr::from_ptr(mem::transmute(tag_bytes.as_ptr())) }; + + // message must not exceed LOGGING_MSG_MAX_LEN + // therefore split log message into multiple log calls + let mut writer = PlatformLogWriter::new(record.level(), tag); + + // If a custom tag is used, add the module path to the message. + // Use PlatformLogWriter to output chunks if they exceed max size. + let _ = if custom_tag.is_some() { + fmt::write(&mut writer, format_args!("{}: {}", module_path, *record.args())) + } else { + fmt::write(&mut writer, *record.args()) + }; + + // output the remaining message (this would usually be the most common case) + writer.flush(); + } + + fn flush(&self) {} +} + +impl AndroidLogger { + fn fill_tag_bytes(&self, array: &mut [u8], tag: &[u8]) { + if tag.len() > LOGGING_TAG_MAX_LEN { + for (input, output) in tag.iter() + .take(LOGGING_TAG_MAX_LEN - 2) + .chain(b"..\0".iter()) + .zip(array.iter_mut()) + { + *output = *input; + } + } else { + for (input, output) in tag.iter() + .chain(b"\0".iter()) + .zip(array.iter_mut()) + { + *output = *input; + } + } + } +} + +/// Filter for android logger. +pub struct Config { + log_level: Option<Level>, + filter: Option<env_logger::filter::Filter>, + tag: Option<CString>, +} + +impl Default for Config { + fn default() -> Self { + Config { + log_level: None, + filter: None, + tag: None, + } + } +} + +impl Config { + /// Change the minimum log level. + /// + /// All values above the set level are logged. For example, if + /// `Warn` is set, the `Error` is logged too, but `Info` isn't. + pub fn with_min_level(mut self, level: Level) -> Self { + self.log_level = Some(level); + self + } + + fn filter_matches(&self, record: &Record) -> bool { + if let Some(ref filter) = self.filter { + filter.matches(&record) + } else { + true + } + } + + pub fn with_filter(mut self, filter: env_logger::filter::Filter) -> Self { + self.filter = Some(filter); + self + } + + pub fn with_tag<S: Into<Vec<u8>>>(mut self, tag: S) -> Self { + self.tag = Some(CString::new(tag).expect("Can't convert tag to CString")); + self + } +} + +struct PlatformLogWriter<'a> { + #[cfg(target_os = "android")] priority: LogPriority, + #[cfg(not(target_os = "android"))] priority: Level, + len: usize, + last_newline_index: usize, + tag: &'a CStr, + buffer: [u8; LOGGING_MSG_MAX_LEN + 1], +} + +impl<'a> PlatformLogWriter<'a> { + #[cfg(target_os = "android")] + pub fn new(level: Level, tag: &CStr) -> PlatformLogWriter { + PlatformLogWriter { + priority: match level { + Level::Warn => LogPriority::WARN, + Level::Info => LogPriority::INFO, + Level::Debug => LogPriority::DEBUG, + Level::Error => LogPriority::ERROR, + Level::Trace => LogPriority::VERBOSE, + }, + len: 0, + last_newline_index: 0, + tag, + buffer: unsafe { mem::uninitialized() }, + } + } + + #[cfg(not(target_os = "android"))] + pub fn new(level: Level, tag: &CStr) -> PlatformLogWriter { + PlatformLogWriter { + priority: level, + len: 0, + last_newline_index: 0, + tag, + buffer: unsafe { mem::uninitialized() }, + } + } + + /// Flush some bytes to android logger. + /// + /// If there is a newline, flush up to it. + /// If ther was no newline, flush all. + /// + /// Not guaranteed to flush everything. + fn temporal_flush(&mut self) { + let total_len = self.len; + + if total_len == 0 { + return; + } + + if self.last_newline_index > 0 { + let copy_from_index = self.last_newline_index; + let remaining_chunk_len = total_len - copy_from_index; + + self.output_specified_len(copy_from_index); + self.copy_bytes_to_start(copy_from_index, remaining_chunk_len); + self.len = remaining_chunk_len; + } else { + self.output_specified_len(total_len); + self.len = 0; + } + self.last_newline_index = 0; + } + + /// Flush everything remaining to android logger. + fn flush(&mut self) { + let total_len = self.len; + + if total_len == 0 { + return; + } + + self.output_specified_len(total_len); + self.len = 0; + self.last_newline_index = 0; + } + + /// Output buffer up until the \0 which will be placed at `len` position. + fn output_specified_len(&mut self, len: usize) { + let mut last_byte: u8 = b'\0'; + mem::swap(&mut last_byte, unsafe { + self.buffer.get_unchecked_mut(len) + }); + + let msg: &CStr = unsafe { CStr::from_ptr(mem::transmute(self.buffer.as_ptr())) }; + android_log(self.priority, self.tag, msg); + + *unsafe { self.buffer.get_unchecked_mut(len) } = last_byte; + } + + /// Copy `len` bytes from `index` position to starting position. + fn copy_bytes_to_start(&mut self, index: usize, len: usize) { + let src = unsafe { self.buffer.as_ptr().offset(index as isize) }; + let dst = self.buffer.as_mut_ptr(); + unsafe { ptr::copy(src, dst, len) }; + } +} + +impl<'a> fmt::Write for PlatformLogWriter<'a> { + fn write_str(&mut self, s: &str) -> fmt::Result { + let mut incomming_bytes = s.as_bytes(); + + while !incomming_bytes.is_empty() { + let len = self.len; + + // write everything possible to buffer and mark last \n + let new_len = len + incomming_bytes.len(); + let last_newline = self.buffer[len..LOGGING_MSG_MAX_LEN] + .iter_mut() + .zip(incomming_bytes) + .enumerate() + .fold(None, |acc, (i, (output, input))| { + *output = *input; + if *input == b'\n' { + Some(i) + } else { + acc + } + }); + + // update last \n index + if let Some(newline) = last_newline { + self.last_newline_index = len + newline; + } + + // calculate how many bytes were written + let written_len = if new_len <= LOGGING_MSG_MAX_LEN { + // if the len was not exceeded + self.len = new_len; + new_len - len // written len + } else { + // if new length was exceeded + self.len = LOGGING_MSG_MAX_LEN; + self.temporal_flush(); + + LOGGING_MSG_MAX_LEN - len // written len + }; + + incomming_bytes = &incomming_bytes[written_len..]; + } + + Ok(()) + } +} + +/// Send a log record to Android logging backend. +/// +/// This action does not require initialization. However, without initialization it +/// will use the default filter, which allows all logs. +pub fn log(record: &Record) { + ANDROID_LOGGER.log(record) +} + +/// Initializes the global logger with an android logger. +/// +/// This can be called many times, but will only initialize logging once, +/// and will not replace any other previously initialized logger. +/// +/// It is ok to call this at the activity creation, and it will be +/// repeatedly called on every lifecycle restart (i.e. screen rotation). +pub fn init_once(config: Config) { + if let Err(err) = log::set_logger(&*ANDROID_LOGGER) { + debug!("android_logger: log::set_logger failed: {}", err); + } else { + if let Some(level) = config.log_level { + log::set_max_level(level.to_level_filter()); + } + *ANDROID_LOGGER + .config + .write() + .expect("failed to acquire android_log filter lock for write") = config; + } +} |