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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
extern crate path_dedot;

use std::path::{Path, PathBuf};
use std::io;

/// Current working directory.
pub use path_dedot::CWD;

/// The main separator for the target OS.
pub use path_dedot::MAIN_SEPARATOR;

/// Make `Path` and `PathBuf` have `absolutize` and `absolutize_virtually` method.
pub trait Absolutize {
    /// Get an absolute path. This works even if the path does not exist.
    ///
    /// Please read the following examples to know the parsing rules.
    ///
    /// # Examples
    ///
    /// The dots in a path will be parsed even if it is already an absolute path (which means the path starts with a `MAIN_SEPARATOR` on Unix-like systems).
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("/path/to/123/456");
    ///
    ///     assert_eq!("/path/to/123/456", p.absolutize().unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("/path/to/./123/../456");
    ///
    ///     assert_eq!("/path/to/456", p.absolutize().unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// If a path starts with a single dot, the dot means **current working directory**.
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("./path/to/123/456");
    ///
    ///     assert_eq!(Path::join(&CWD, Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().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_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("../path/to/123/456");
    ///
    ///     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.absolutize().unwrap().to_str().unwrap());
    ///        }
    ///        None => {
    ///            assert_eq!(Path::join(Path::new("/"), Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
    ///        }
    ///     }
    ///
    /// }
    /// ```
    ///
    /// A path which does not start with a `MAIN_SEPARATOR`, **Single Dot** and **Double Dots**, will act like having a single dot at the start when `absolutize` method is used.
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("path/to/123/456");
    ///
    ///     assert_eq!(Path::join(&CWD, Path::new("path/to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("path/../../to/123/456");
    ///
    ///     let cwd_parent = CWD.parent();
    ///
    ///     match cwd_parent {
    ///       Some(cwd_parent) => {
    ///            assert_eq!(Path::join(&cwd_parent, Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
    ///       }
    ///       None => {
    ///           assert_eq!(Path::join(Path::new("/"), Path::new("to/123/456")).to_str().unwrap(), p.absolutize().unwrap().to_str().unwrap());
    ///       }
    /// }
    ///
    /// }
    /// ```
    fn absolutize(&self) -> io::Result<PathBuf>;

    /// Get an absolute path **only under a specific directory**. This works even if the path does not exist.
    ///
    /// Please read the following examples to know the parsing rules.
    ///
    /// # Examples
    ///
    /// The dots in a path will be parsed even if it is already an absolute path (which means the path starts with a `MAIN_SEPARATOR` on Unix-like systems).
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("/path/to/123/456");
    ///
    ///     assert_eq!("/path/to/123/456", p.absolutize_virtually("/").unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("/path/to/./123/../456");
    ///
    ///     assert_eq!("/path/to/456", p.absolutize_virtually("/").unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// Every absolute path should under the virtual root.
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use std::io::ErrorKind;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("/path/to/123/456");
    ///
    ///     assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
    ///
    /// }
    /// ```
    ///
    /// Every relative path should under the virtual root.
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use std::io::ErrorKind;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("./path/to/123/456");
    ///
    ///     assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
    ///
    /// }
    /// ```
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use std::io::ErrorKind;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("../path/to/123/456");
    ///
    ///     assert_eq!(ErrorKind::InvalidInput, p.absolutize_virtually("/virtual/root").unwrap_err().kind());
    ///
    /// }
    /// ```
    ///
    /// A path which does not start with a `MAIN_SEPARATOR`, **Single Dot** and **Double Dots**, will be located in the virtual root after the `absolutize_virtually` method is used.
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("path/to/123/456");
    ///
    ///     assert_eq!("/virtual/root/path/to/123/456", p.absolutize_virtually("/virtual/root").unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    ///
    /// ```
    /// extern crate path_absolutize;
    ///
    /// use std::path::Path;
    ///
    /// use path_absolutize::*;
    ///
    /// if cfg!(not(windows)) {
    ///
    ///     let p = Path::new("path/to/../../../../123/456");
    ///
    ///     assert_eq!("/virtual/root/123/456", p.absolutize_virtually("/virtual/root").unwrap().to_str().unwrap());
    ///
    /// }
    /// ```
    fn absolutize_virtually<P: AsRef<Path>>(&self, virtual_root: P) -> io::Result<PathBuf>;
}

impl Absolutize for PathBuf {
    fn absolutize(&self) -> io::Result<PathBuf> {
        let path = Path::new(&self);

        path.absolutize()
    }

    fn absolutize_virtually<P: AsRef<Path>>(&self, virtual_root: P) -> io::Result<PathBuf> {
        let path = Path::new(&self);

        path.absolutize_virtually(virtual_root)
    }
}

mod unix;
mod windows;