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 all 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
245 changes: 245 additions & 0 deletions src/libstd/path.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2220,6 +2220,92 @@ impl Path {
fs::canonicalize(self)
}

/// 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,
/// this leaves symbolic links intact and does not validate that the target exists.
///
/// This may change the meaning of a path involving symbolic links and parent directory
/// references.
///
/// # Examples
///
/// ```no_run
/// use std::path::{Path, PathBuf};
///
/// let path = Path::new("/recipes/./snacks/../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.clean(), PathBuf::from("../../lots/of/separators"));
/// let path = Path::new("/../../../cannot_go_above_root");
/// assert_eq!(path.clean(), PathBuf::from("/cannot_go_above_root"));
/// ```
#[unstable(feature = "path_clean", issue = "47402")]
pub fn clean(&self) -> PathBuf {
let mut stack: Vec<Component> = vec![];

// We assume .components() removes redundant consecutive path separators.
// Note that .components() also does some normalization of '.' on its own anyways.
// This '.' normalization happens to be compatible with the approach below.
for component in self.components() {
match component {
// Drop CurDir components, do not even push onto the stack.
Component::CurDir => {},

// For ParentDir components, we need to use the contents of the stack.
Component::ParentDir => {
// Look at the top element of stack, if any.
let top = stack.last().cloned();

match top {
// A component is on the stack, need more pattern matching.
Some(c) => {
match c {
// Push the ParentDir on the stack.
Component::Prefix(_) => { stack.push(component); },

// The parent of a RootDir is itself, so drop the ParentDir (no-op).
Component::RootDir => {},

// A CurDir should never be found on the stack,
// since they are dropped when seen.
Component::CurDir => { unreachable!(); },

// If a ParentDir is found, it must be due to it
// piling up at the start of a path.
// Push the new ParentDir onto the stack.
Component::ParentDir => { stack.push(component); },

// If a Normal is found, pop it off.
Component::Normal(_) => { let _ = stack.pop(); }
}
},

// Stack is empty, so path is empty, just push.
None => { stack.push(component); }
}
},

// All others, simply push onto the stack.
_ => { stack.push(component); },
}
}

// If an empty PathBuf would be returned, instead return CurDir ('.').
if stack.is_empty() {
return PathBuf::from(Component::CurDir.as_os_str());
}

let mut norm_path = PathBuf::new();

for item in &stack {
norm_path.push(item.as_os_str());
}

norm_path
}

/// Reads a symbolic link, returning the file that the link points to.
///
/// This is an alias to [`fs::read_link`].
Expand Down Expand Up @@ -4020,6 +4106,165 @@ mod tests {
assert_eq!(format!("a{:#<5}b", Path::new("a").display()), "aa####b");
}

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

if cfg!(unix) {
tc!("", ".");
tc!("/", "/");
tc!("//", "/"); /* Double-slash root is a separate entity in POSIX,
but in Rust we treat it as a normal root slash. */
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 {
// Drive-absolute paths.
tc!(r#"X:\ABC\DEF"#, r#"X:\ABC\DEF"#);
Copy link
Member

Choose a reason for hiding this comment

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

Nit pick. Unless your path contains a " you could just lose the #s

tc!(r"X:\ABC\DEF", r"X:\ABC\DEF");

I think this is much less noisy.

tc!(r#"X:\"#, r#"X:\"#);
tc!(r#"X:\ABC\"#, r#"X:\ABC"#);
// tc!(r#"X:\ABC\DEF. ."#, r#"X:\ABC\DEF"#);
tc!(r#"X:/ABC/DEF"#, r#"X:\ABC\DEF"#);
tc!(r#"X:\ABC\..\XYZ"#, r#"X:\XYZ"#);
tc!(r#"X:\ABC\..\..\.."#, r#"X:\"#);

// Drive-relative paths.
tc!(r#"X:DEF\GHI"#, r#"X:DEF\GHI"#);
tc!(r#"X:"#, r#"X:"#);
// tc!(r#"X:DEF. ."#, r#"X:DEF"#);
tc!(r#"Y:"#, r#"Y:"#);
tc!(r#"Z:"#, r#"Z:"#);
tc!(r#"X:ABC\..\XYZ"#, r#"X:XYZ"#);
tc!(r#"X:ABC\..\..\.."#, r#"X:..\.."#);

// Rooted paths.
tc!(r#"\ABC\DEF"#, r#"\ABC\DEF"#);
tc!(r#"\"#, r#"\"#);
// tc!(r#"\ABC\DEF. ."#, r#"\ABC\DEF"#);
tc!(r#"/ABC/DEF"#, r#"\ABC\DEF"#);
tc!(r#"\ABC\..\XYZ"#, r#"\XYZ"#);
tc!(r#"\ABC\..\..\.."#, r#"\"#);

// Relative paths.
tc!(r#"ABC\DEF"#, r#"ABC\DEF"#);
tc!(r#"."#, r#"."#);
// tc!(r#"ABC\DEF. ."#, r#"ABC\DEF"#);
tc!(r#"ABC/DEF"#, r#"ABC\DEF"#);
tc!(r#"..\ABC"#, r#"..\ABC"#);
tc!(r#"ABC\..\..\.."#, r#"..\.."#);

// UNC absolute paths.
tc!(r#"\\server\share\ABC\DEF"#, r#"\\server\share\ABC\DEF"#);
tc!(r#"\\server"#, r#"\\server\"#);
tc!(r#"\\server\share"#, r#"\\server\share\"#);
// tc!(r#"\\server\share\ABC. ."#, r#"\\server\share\ABC"#);
// tc!(r#"//server/share/ABC/DEF"#, r#"\\server\share\ABC\DEF"#);
tc!(r#"\\server\share\ABC\..\XYZ"#, r#"\\server\share\XYZ"#);
tc!(r#"\\server\share\ABC\..\..\.."#, r#"\\server\share\"#);

// Local device paths.
tc!(r#"\\.\COM20"#, r#"\\.\COM20\"#);
tc!(r#"\\.\pipe\mypipe"#, r#"\\.\pipe\mypipe"#);
// tc!(r#"\\.\X:\ABC\DEF. ."#, r#"\\.\X:\ABC\DEF"#);
// tc!(r#"\\.\X:/ABC/DEF"#, r#"\\.\X:\ABC\DEF"#);
tc!(r#"\\.\X:\ABC\..\XYZ"#, r#"\\.\X:\XYZ"#);
// tc!(r#"\\.\X:\ABC\..\..\C:\"#, r#"\\.\C:\"#);
tc!(r#"\\.\pipe\mypipe\..\notmine"#, r#"\\.\pipe\notmine"#);

// More local device paths.
// tc!(r#"COM1"#, r#"\\.\COM1"#);
// tc!(r#"X:\COM1"#, r#"\\.\COM1"#);
// tc!(r#"X:COM1"#, r#"\\.\COM1"#);
// tc!(r#"valid\COM1"#, r#"\\.\COM1"#);
// tc!(r#"X:\notvalid\COM1"#, r#"\\.\COM1"#);
// tc!(r#"X:\COM1.blah"#, r#"\\.\COM1"#);
// tc!(r#"X:\COM1:blah"#, r#"\\.\COM1"#);
// tc!(r#"X:\COM1 .blah"#, r#"\\.\COM1"#);
// tc!(r#"\\.\X:\COM1"#, r#"\\.\X:\COM1"#);
// tc!(r#"\\abc\xyz\COM1"#, r#"\\abc\xyz\COM1"#);

// Root local device paths.
tc!(r#"\\?\X:\ABC\DEF"#, r#"\\?\X:\ABC\DEF"#);
tc!(r#"\\?\X:\"#, r#"\\?\X:\"#);
tc!(r#"\\?\X:"#, r#"\\?\X:"#);
tc!(r#"\\?\X:\COM1"#, r#"\\?\X:\COM1"#);
// tc!(r#"\\?\X:\ABC\DEF. ."#, r#"\\?\X:\ABC\DEF"#);
// tc!(r#"\\?\X:/ABC/DEF"#, r#"\\?\X:\ABC\DEF"#);
tc!(r#"\\?\X:\ABC\..\XYZ"#, r#"\\?\X:\XYZ"#);
tc!(r#"\\?\X:\ABC\..\..\.."#, r#"\\?\X:\"#);

// More root local device paths.
// tc!(r#"\??\X:\ABC\DEF"#, r#"X:\??\X:\ABC\DEF"#);
// tc!(r#"\??\X:\"#, r#"X:\??\X:\"#);
// tc!(r#"\??\X:"#, r#"X:\??\X:"#);
// tc!(r#"\??\X:\COM1"#, r#"X:\??\X:\COM1"#);
// tc!(r#"\??\X:\ABC\DEF. ."#, r#"X:\??\X:\ABC\DEF"#);
// tc!(r#"\??\X:/ABC/DEF"#, r#"X:\??\X:\ABC\DEF"#);
// tc!(r#"\??\X:\ABC\..\XYZ"#, r#"X:\??\X:\XYZ"#);
// tc!(r#"\??\X:\ABC\..\..\.."#, r#"X:\"#);

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?
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"#);
}
}

#[test]
fn into_rc() {
let orig = "hello/world";
Expand Down