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.

Sign up for GitHub

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

Jump to bottom

Adding Path.normalize() method #47363

Closed
wants to merge 17 commits into from
Closed

Adding Path.normalize() method #47363

Changes from 2 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
5c5bee3
Added normalize, and working on tests
Nov 11, 2017
856fa14
About to catch up from upstream
Jan 11, 2018
4d8302e
Marking as unstable
Jan 11, 2018
89255eb
Merge branch 'master' into master
Jan 11, 2018
c2c3e0d
Merge branch 'master' of github.com:rust-lang/rust
Jan 12, 2018
2dd8a81
Fixing incorrect braces, unstable flag, and too-long comment lines
Jan 13, 2018
5d5c747
Merge branch 'master' of github.com:rust-lang/rust
Jan 13, 2018
46b9ba3
Removing `mut` and changing `.as_ref()` calls to `.as_os_str()`
Jan 14, 2018
1b67915
Merge branch 'master' of github.com:rust-lang/rust
Jan 14, 2018
9f66ba4
Adding missing (?) "test" attribute to `into_rc`
Jan 16, 2018
9020f4e
Merge branch 'master' of github.com:rust-lang/rust
Jan 16, 2018
3ee1f8b
Renaming `normalize` to `clean`, and updating comments and docs to re…
Feb 6, 2018
579c308
Merged
Feb 6, 2018
5cebcca
Renamed feature name to remove spaces
Feb 6, 2018
ab1ed7a
Adding Windows-specific tests
Feb 6, 2018
6f59d0f
Merged from Windows VM
Feb 6, 2018
9942a0f
Missed some `tn` -> `tc` renames
Feb 6, 2018
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
130 changes: 65 additions & 65 deletions src/libstd/path.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2220,7 +2220,7 @@ impl Path {
fs::canonicalize(self)
}

/// Returns the normalized (or "cleaned") form of the path with all current
/// Returns a cleaned representation of the path with all current
/// directory (.) and parent directory (..) references resolved.
///
/// This is a purely logical calculation; the file system is not accessed. Namely,
Expand All @@ -2235,14 +2235,14 @@ impl Path {
/// use std::path::{Path, PathBuf};
///
/// let path = Path::new("/recipes/./snacks/../desserts/banana_creme_pie.txt");
/// assert_eq!(path.normalize(), PathBuf::from("/recipes/desserts/banana_creme_pie.txt"));
/// assert_eq!(path.clean(), PathBuf::from("/recipes/desserts/banana_creme_pie.txt"));
/// let path = Path::new("../.././lots///of////./separators/");
/// assert_eq!(path.normalize(), PathBuf::from("../../lots/of/separators"));
/// assert_eq!(path.clean(), PathBuf::from("../../lots/of/separators"));
/// let path = Path::new("/../../../cannot_go_above_root");
/// assert_eq!(path.normalize(), PathBuf::from("/cannot_go_above_root"));
/// assert_eq!(path.clean(), PathBuf::from("/cannot_go_above_root"));
/// ```
#[unstable(feature = "path normalize", issue = "47402")]
pub fn normalize(&self) -> PathBuf {
#[unstable(feature = "path cleaning", issue = "47402")]
Copy link
Member

Choose a reason for hiding this comment

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

Feature names usually don't contain spaces.

pub fn clean(&self) -> PathBuf {
let mut stack: Vec<Component> = vec![];

// We assume .components() removes redundant consecutive path separators.
Expand Down Expand Up @@ -4107,77 +4107,77 @@ mod tests {
}

#[test]
fn test_normalize() {
macro_rules! tn(
pub fn test_clean() {
macro_rules! tc(
($path:expr, $expected:expr) => ( {
let actual = PathBuf::from($path).normalize();
let mut actual = PathBuf::from($path).clean();
assert!(actual.to_str() == Some($expected),
"normalizing {:?}: Expected {:?}, got {:?}",
"cleaning {:?}: Expected {:?}, got {:?}",
$path, $expected,
actual.to_str().unwrap());
});
);

if cfg!(unix) {
tn!("", ".");
tn!("/", "/");
tn!("//", "/"); /* Double-slash root is a separate entity in POSIX,
tc!("", ".");
tc!("/", "/");
tc!("//", "/"); /* Double-slash root is a separate entity in POSIX,
but in Rust we treat it as a normal root slash. */
tn!("foo", "foo");
tn!(".", ".");
tn!("..", "..");
tn!(".foo", ".foo");
tn!("..foo", "..foo");
tn!("/foo", "/foo");
tn!("//foo", "/foo");
tn!("./foo/", "foo");
tn!("../foo/", "../foo");
tn!("/foo/bar", "/foo/bar");
tn!("foo/bar", "foo/bar");
tn!("foo/.", "foo");
tn!("foo//bar", "foo/bar");
tn!("./foo//bar//", "foo/bar");

tn!("foo/bar/baz/..", "foo/bar");
tn!("foo/bar/baz/../", "foo/bar");
tn!("foo/bar/baz/../..", "foo");
tn!("foo/bar/baz/../../..", ".");
tn!("foo/bar/baz/../../../..", "..");
tn!("foo/bar/baz/../../../../..", "../..");
tn!("/foo/bar/baz/../../../../..", "/");
tn!("foo/../bar/../baz/../", ".");
tn!("/.", "/");
tn!("/..", "/");
tn!("/../../", "/");
tc!("foo", "foo");
tc!(".", ".");
tc!("..", "..");
tc!(".foo", ".foo");
tc!("..foo", "..foo");
tc!("/foo", "/foo");
tc!("//foo", "/foo");
tc!("./foo/", "foo");
tc!("../foo/", "../foo");
tc!("/foo/bar", "/foo/bar");
tc!("foo/bar", "foo/bar");
tc!("foo/.", "foo");
tc!("foo//bar", "foo/bar");
tc!("./foo//bar//", "foo/bar");

tc!("foo/bar/baz/..", "foo/bar");
tc!("foo/bar/baz/../", "foo/bar");
tc!("foo/bar/baz/../..", "foo");
tc!("foo/bar/baz/../../..", ".");
tc!("foo/bar/baz/../../../..", "..");
tc!("foo/bar/baz/../../../../..", "../..");
tc!("/foo/bar/baz/../../../../..", "/");
tc!("foo/../bar/../baz/../", ".");
tc!("/.", "/");
tc!("/..", "/");
tc!("/../../", "/");
} else {
tn!(r#"a\b\c"#, r#"a\b\c"#);
tn!(r#"a/b\c"#, r#"a\b\c"#);
tn!(r#"a/b\c\"#, r#"a\b\c"#);
tn!(r#"a/b\c/"#, r#"a\b\c"#);
tn!(r#"\"#, r#"\"#);
tn!(r#"\\"#, r#"\"#);
tn!(r#"/"#, r#"\"#);
tn!(r#"//"#, r#"\"#);

tn!(r#"C:\a\b"#, r#"C:\a\b"#);
tn!(r#"C:\"#, r#"C:\"#);
tn!(r#"C:\."#, r#"C:\"#);
tn!(r#"C:\.."#, r#"C:\"#);
tn!(r#"C:a"#, r#"C:a"#);
tn!(r#"C:."#, r#"C:."#);
tn!(r#"C:.."#, r#"C:.."#);
tc!(r#"a\b\c"#, r#"a\b\c"#);
tc!(r#"a/b\c"#, r#"a\b\c"#);
tc!(r#"a/b\c\"#, r#"a\b\c"#);
tc!(r#"a/b\c/"#, r#"a\b\c"#);
tc!(r#"\"#, r#"\"#);
tc!(r#"\\"#, r#"\"#);
tc!(r#"/"#, r#"\"#);
tc!(r#"//"#, r#"\"#);

tc!(r#"C:\a\b"#, r#"C:\a\b"#);
tc!(r#"C:\"#, r#"C:\"#);
tc!(r#"C:\."#, r#"C:\"#);
tc!(r#"C:\.."#, r#"C:\"#);
tc!(r#"C:a"#, r#"C:a"#);
tc!(r#"C:."#, r#"C:."#);
tc!(r#"C:.."#, r#"C:.."#);

// Should these not have a trailing slash?
tn!(r#"\\server\share"#, r#"\\server\share\"#);
tn!(r#"\\server\share\a\b"#, r#"\\server\share\a\b"#);
tn!(r#"\\server\share\a\.\b"#, r#"\\server\share\a\b"#);
tn!(r#"\\server\share\a\..\b"#, r#"\\server\share\b"#);
tn!(r#"\\server\share\a\b\"#, r#"\\server\share\a\b"#);

tn!(r#"\\?\a\b"#, r#"\\?\a\b"#);
tn!(r#"\\?\a/\\b\"#, r#"\\?\a/\\b"#);
tn!(r#"\\?\a/\\b/"#, r#"\\?\a/\\b/"#);
tn!(r#"\\?\a\b"#, r#"\\?\a\b"#);
tc!(r#"\\server\share"#, r#"\\server\share\"#);
tc!(r#"\\server\share\a\b"#, r#"\\server\share\a\b"#);
tc!(r#"\\server\share\a\.\b"#, r#"\\server\share\a\b"#);
tc!(r#"\\server\share\a\..\b"#, r#"\\server\share\b"#);
tc!(r#"\\server\share\a\b\"#, r#"\\server\share\a\b"#);

tc!(r#"\\?\a\b"#, r#"\\?\a\b"#);
tc!(r#"\\?\a/\\b\"#, r#"\\?\a/\\b"#);
tc!(r#"\\?\a/\\b/"#, r#"\\?\a/\\b/"#);
tc!(r#"\\?\a\b"#, r#"\\?\a\b"#);
}
}

Expand Down