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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/*! # Path Dedot This is a library for extending `Path` and `PathBuf` in order to parse the path which contains dots. Please read the following examples to know the parsing rules. ## Examples If a path starts with a single dot, the dot means your program's **current working directory** (CWD). ```rust extern crate path_dedot; use std::path::Path; use std::env; use path_dedot::*; let p = Path::new("./path/to/123/456"); # if cfg!(unix) { 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 the CWD. If the CWD is **root**, the parent is still **root**. ```rust extern crate path_dedot; use std::path::Path; use std::env; use path_dedot::*; let p = Path::new("../path/to/123/456"); let cwd = env::current_dir().unwrap(); let cwd_parent = cwd.parent(); # if cfg!(unix) { 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()); } } # } ``` In addition to 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. ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; let p = Path::new("/path/to/../123/456/./777"); # if cfg!(unix) { assert_eq!("/path/123/456/777", p.parse_dot().unwrap().to_str().unwrap()); # } ``` ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; let p = Path::new("/path/to/../123/456/./777/.."); # if cfg!(unix) { 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. ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; let p = Path::new("path/to/../123/456/./777/.."); # if cfg!(unix) { 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. ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; let p = Path::new("path/to/../../../../123/456/./777/.."); # if cfg!(unix) { assert_eq!("123/456", p.parse_dot().unwrap().to_str().unwrap()); # } ``` ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; let p = Path::new("/path/to/../../../../123/456/./777/.."); # if cfg!(unix) { assert_eq!("/123/456", p.parse_dot().unwrap().to_str().unwrap()); # } ``` ## Caching By default, the `parse_dot` method creates a new `PathBuf` instance of the CWD every time in its operation. The overhead is obvious. Although it allows us to safely change the CWD at runtime by the program itself (e.g. using the `std::env::set_current_dir` function) or outside controls (e.g. using gdb to call `chdir`), we don't need that in most cases. In order to parse paths with better performance, this crate provides two ways to cache the CWD. ### lazy_static_cache Enabling the `lazy_static_cache` feature can let this crate use `lazy_static` to cache the CWD. It's thread-safe and does not need to modify any code, but once the CWD is cached, it cannot be changed anymore at runtime. ```toml [dependencies.path-dedot] version = "*" features = ["lazy_static_cache"] ``` ### unsafe_cache Enabling the `unsafe_cache` feature can let this crate use a mutable static variable to cache the CWD. It allows the program to change the CWD at runtime by the program itself, but it's not thread-safe. You need to use the `update_cwd` function to initialize the CWD first. The function should also be used to update the CWD after the CWD is changed. ```toml [dependencies.path-dedot] version = "*" features = ["unsafe_cache"] ``` ```rust extern crate path_dedot; use std::path::Path; use path_dedot::*; # #[cfg(feature = "unsafe_cache")] unsafe { update_cwd(); } let p = Path::new("./path/to/123/456"); println!("{}", p.parse_dot().unwrap().to_str().unwrap()); std::env::set_current_dir("/").unwrap(); # #[cfg(feature = "unsafe_cache")] unsafe { update_cwd(); } println!("{}", p.parse_dot().unwrap().to_str().unwrap()); ``` ## Benchmark #### No-cache ```bash cargo bench ``` #### lazy_static_cache ```bash cargo bench --features lazy_static_cache ``` #### unsafe_cache ```bash cargo bench --features unsafe_cache ``` */ #[cfg(all(feature = "lazy_static_cache", feature = "unsafe_cache"))] compile_error!("You can only enable at most one caching mechanism for `path-dedot`."); #[macro_use] extern crate lazy_static; use std::ffi::OsString; use std::io; use std::path::{self, PathBuf}; mod parse_dot; #[macro_use] mod macros; #[cfg(unix)] mod unix; #[cfg(windows)] mod windows; #[cfg(feature = "unsafe_cache")] mod unsafe_cwd; pub use parse_dot::*; #[cfg(windows)] pub use windows::ParsePrefix; lazy_static! { /// The main separator for the target OS. pub static ref MAIN_SEPARATOR: OsString = OsString::from(path::MAIN_SEPARATOR.to_string()); } impl ParseDot for PathBuf { #[inline] fn parse_dot(&self) -> io::Result<PathBuf> { self.as_path().parse_dot() } } #[cfg(feature = "lazy_static_cache")] lazy_static! { /// Current working directory. pub static ref CWD: PathBuf = std::env::current_dir().unwrap(); } #[cfg(feature = "unsafe_cache")] pub static mut CWD: unsafe_cwd::UnsafeCWD = unsafe_cwd::UnsafeCWD::new(); #[cfg(feature = "unsafe_cache")] /// Initialize or update the CWD cached in the `path-dedot` crate after using the `std::env::set_current_dir` function. It is not a safe operation. Make sure there is no `parse_dot` method running at this moment. #[allow(clippy::missing_safety_doc)] pub unsafe fn update_cwd() { CWD.update(); }