1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
#[macro_use] extern crate lazy_static; mod cwd; use std::ffi::OsString; use std::io; use std::path::{self, Path, PathBuf}; #[cfg(windows)] use std::path::{Component, PrefixComponent}; lazy_static! { /// The main separator for the target OS. pub static ref MAIN_SEPARATOR: OsString = { OsString::from(path::MAIN_SEPARATOR.to_string()) }; } #[doc(hidden)] pub static mut CWD: cwd::CWD = cwd::CWD::new(); /// Update the CWD cached in the `path-dedot` crate after using the `std::env::set_current_dir` function. Updating might fail when there are other threads using this function. Return whether the updating is successful. #[allow(clippy::missing_safety_doc)] pub unsafe fn update_cwd() -> bool { CWD.update().is_some() } #[cfg(windows)] #[doc(hidden)] pub trait ParsePrefix { #[cfg(windows)] fn get_path_prefix(&self) -> Option<PrefixComponent>; } #[cfg(windows)] impl ParsePrefix for Path { fn get_path_prefix(&self) -> Option<PrefixComponent> { let first_component = self.components().next(); match first_component.unwrap() { Component::Prefix(prefix_component) => Some(prefix_component), _ => None, } } } #[cfg(windows)] impl ParsePrefix for PathBuf { fn get_path_prefix(&self) -> Option<PrefixComponent> { let first_component = self.components().next(); match first_component.unwrap() { Component::Prefix(prefix_component) => Some(prefix_component), _ => None, } } } /// Make `Path` and `PathBuf` have `parse_dot` method. pub trait ParseDot { /// Remove dots in the path and create a new `PathBuf` instance. /// /// Please read the following examples to know the parsing rules. /// /// # Examples /// /// If a path starts with a single dot, the dot means **current working directory**. /// /// ``` /// extern crate path_dedot; /// /// use std::env; /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("./path/to/123/456"); /// /// assert_eq!( /// Path::join(env::current_dir().unwrap().as_path(), Path::new("path/to/123/456")) /// .to_str() /// .unwrap(), /// p.parse_dot().unwrap().to_str().unwrap() /// ); /// } /// ``` /// /// If a path starts with a pair of dots, the dots means the parent of **current working directory**. If **current working directory** is **root**, the parent is still **root**. /// /// ``` /// extern crate path_dedot; /// /// use std::env; /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("../path/to/123/456"); /// /// let cwd = env::current_dir().unwrap(); /// /// let cwd_parent = cwd.parent(); /// /// match cwd_parent { /// Some(cwd_parent) => { /// assert_eq!( /// Path::join(&cwd_parent, Path::new("path/to/123/456")).to_str().unwrap(), /// p.parse_dot().unwrap().to_str().unwrap() /// ); /// } /// None => { /// assert_eq!( /// Path::join(Path::new("/"), Path::new("path/to/123/456")).to_str().unwrap(), /// p.parse_dot().unwrap().to_str().unwrap() /// ); /// } /// } /// } /// ``` /// /// Besides starting with, the **Single Dot** and **Double Dots** can also be placed to other positions. **Single Dot** means noting and will be ignored. **Double Dots** means the parent. /// /// ``` /// extern crate path_dedot; /// /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("/path/to/../123/456/./777"); /// /// assert_eq!("/path/123/456/777", p.parse_dot().unwrap().to_str().unwrap()); /// } /// ``` /// /// ``` /// extern crate path_dedot; /// /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("/path/to/../123/456/./777/.."); /// /// assert_eq!("/path/123/456", p.parse_dot().unwrap().to_str().unwrap()); /// } /// ``` /// /// You should notice that `parse_dot` method does **not** aim to get an **absolute path**. A path which does not start with a `MAIN_SEPARATOR`, **Single Dot** and **Double Dots**, will not have each of them after the `parse_dot` method is used. /// /// ``` /// extern crate path_dedot; /// /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("path/to/../123/456/./777/.."); /// /// assert_eq!("path/123/456", p.parse_dot().unwrap().to_str().unwrap()); /// } /// ``` /// /// **Double Dots** which is not placed at the start cannot get the parent beyond the original path. Why not? With this constraint, you can insert an absolute path to the start as a virtual root in order to protect your file system from being exposed. /// /// ``` /// extern crate path_dedot; /// /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("path/to/../../../../123/456/./777/.."); /// /// assert_eq!("123/456", p.parse_dot().unwrap().to_str().unwrap()); /// } /// ``` /// /// ``` /// extern crate path_dedot; /// /// use std::path::Path; /// /// use path_dedot::*; /// /// if cfg!(not(windows)) { /// let p = Path::new("/path/to/../../../../123/456/./777/.."); /// /// assert_eq!("/123/456", p.parse_dot().unwrap().to_str().unwrap()); /// } /// ``` fn parse_dot(&self) -> io::Result<PathBuf>; } impl ParseDot for PathBuf { fn parse_dot(&self) -> io::Result<PathBuf> { let path = Path::new(&self); path.parse_dot() } } mod unix; mod windows;