Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add lossless debug implementation for unix OsStrs #46798

Merged
merged 1 commit into from
Dec 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/libstd/sys/redox/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use mem;
use rc::Rc;
use sync::Arc;
use sys_common::{AsInner, IntoInner};
use sys_common::bytestring::debug_fmt_bytestring;
use std_unicode::lossy::Utf8Lossy;

#[derive(Clone, Hash)]
Expand All @@ -31,7 +32,7 @@ pub struct Slice {

impl fmt::Debug for Slice {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
fmt::Debug::fmt(&Utf8Lossy::from_bytes(&self.inner), formatter)
debug_fmt_bytestring(&self.inner, formatter)
}
}

Expand Down
3 changes: 2 additions & 1 deletion src/libstd/sys/unix/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use mem;
use rc::Rc;
use sync::Arc;
use sys_common::{AsInner, IntoInner};
use sys_common::bytestring::debug_fmt_bytestring;
use std_unicode::lossy::Utf8Lossy;

#[derive(Clone, Hash)]
Expand All @@ -31,7 +32,7 @@ pub struct Slice {

impl fmt::Debug for Slice {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
fmt::Debug::fmt(&Utf8Lossy::from_bytes(&self.inner), formatter)
debug_fmt_bytestring(&self.inner, formatter)
}
}

Expand Down
3 changes: 2 additions & 1 deletion src/libstd/sys/wasm/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use mem;
use rc::Rc;
use sync::Arc;
use sys_common::{AsInner, IntoInner};
use sys_common::bytestring::debug_fmt_bytestring;
use std_unicode::lossy::Utf8Lossy;

#[derive(Clone, Hash)]
Expand All @@ -31,7 +32,7 @@ pub struct Slice {

impl fmt::Debug for Slice {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
fmt::Debug::fmt(&Utf8Lossy::from_bytes(&self.inner), formatter)
debug_fmt_bytestring(&self.inner, formatter)
}
}

Expand Down
56 changes: 56 additions & 0 deletions src/libstd/sys_common/bytestring.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.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.

#![allow(dead_code)]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, on windows builds the function is never called.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it work if we do #[cfg(any(unix, target_os = "redox", target_arch = "wasm32"))] pub mod bytestring instead? I already see some of that for pub mod gnu and pub mod net. That way we continue to catch accidental dead code in this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so - see src\tools\tidy\src\pal.rs

It looks like the goal is to avoid having platform specific code in sys_common and net is a temporary exception. The closest existing file to this is wtf8, which also uses #[allow(dead_code)].


use fmt::{Formatter, Result, Write};
use std_unicode::lossy::{Utf8Lossy, Utf8LossyChunk};

pub fn debug_fmt_bytestring(slice: &[u8], f: &mut Formatter) -> Result {
// Writes out a valid unicode string with the correct escape sequences
fn write_str_escaped(f: &mut Formatter, s: &str) -> Result {
for c in s.chars().flat_map(|c| c.escape_debug()) {
f.write_char(c)?
}
Ok(())
}

f.write_str("\"")?;
for Utf8LossyChunk { valid, broken } in Utf8Lossy::from_bytes(slice).chunks() {
write_str_escaped(f, valid)?;
for b in broken {
write!(f, "\\x{:02X}", b)?;
}
}
f.write_str("\"")
}

#[cfg(test)]
mod tests {
use super::*;
use fmt::{Formatter, Result, Debug};

#[test]
fn smoke() {
struct Helper<'a>(&'a [u8]);

impl<'a> Debug for Helper<'a> {
fn fmt(&self, f: &mut Formatter) -> Result {
debug_fmt_bytestring(self.0, f)
}
}

let input = b"\xF0hello,\tworld";
let expected = r#""\xF0hello,\tworld""#;
let output = format!("{:?}", Helper(input));

assert!(output == expected);
}
}
1 change: 1 addition & 0 deletions src/libstd/sys_common/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ pub mod thread_info;
pub mod thread_local;
pub mod util;
pub mod wtf8;
pub mod bytestring;

cfg_if! {
if #[cfg(any(target_os = "redox", target_os = "l4re"))] {
Expand Down