blob: 98d7382b4e8735f2d26e78fcc951b48847313abc [file] [log] [blame]
Michael J. Spencerdffde992010-11-29 22:28:51 +00001//===-- PathV2.cpp - Implement OS Path Concept ------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the operating system PathV2 API.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Support/PathV2.h"
Michael J. Spencer5b082302011-12-13 23:17:12 +000015#include "llvm/Support/Endian.h"
Michael J. Spencerdffde992010-11-29 22:28:51 +000016#include "llvm/Support/ErrorHandling.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000017#include "llvm/Support/FileSystem.h"
Michael J. Spencerdffde992010-11-29 22:28:51 +000018#include <cctype>
Michael J. Spencer628467e2010-12-28 01:49:01 +000019#include <cstdio>
20#include <cstring>
Michael J. Spencerdffde992010-11-29 22:28:51 +000021
22namespace {
23 using llvm::StringRef;
Zhanyong Wan63cc3a82011-02-11 21:24:40 +000024 using llvm::sys::path::is_separator;
Michael J. Spencerdffde992010-11-29 22:28:51 +000025
26#ifdef LLVM_ON_WIN32
Benjamin Kramer80fd2a12012-02-08 13:13:47 +000027 const char *separators = "\\/";
28 const char prefered_separator = '\\';
Michael J. Spencerdffde992010-11-29 22:28:51 +000029#else
Benjamin Kramer80fd2a12012-02-08 13:13:47 +000030 const char separators = '/';
31 const char prefered_separator = '/';
Michael J. Spencerdffde992010-11-29 22:28:51 +000032#endif
33
Benjamin Kramer7fb86662010-12-17 18:59:09 +000034 StringRef find_first_component(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +000035 // Look for this first component in the following order.
36 // * empty (in this case we return an empty string)
37 // * either C: or {//,\\}net.
38 // * {/,\}
39 // * {.,..}
40 // * {file,directory}name
41
42 if (path.empty())
43 return path;
44
Michael J. Spencerca3a3392010-12-07 03:57:48 +000045#ifdef LLVM_ON_WIN32
Michael J. Spencerdffde992010-11-29 22:28:51 +000046 // C:
47 if (path.size() >= 2 && std::isalpha(path[0]) && path[1] == ':')
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000048 return path.substr(0, 2);
Michael J. Spencerca3a3392010-12-07 03:57:48 +000049#endif
Michael J. Spencerdffde992010-11-29 22:28:51 +000050
51 // //net
52 if ((path.size() > 2) &&
Michael J. Spencerca3a3392010-12-07 03:57:48 +000053 is_separator(path[0]) &&
54 path[0] == path[1] &&
55 !is_separator(path[2])) {
Michael J. Spencerdffde992010-11-29 22:28:51 +000056 // Find the next directory separator.
Michael J. Spencerca3a3392010-12-07 03:57:48 +000057 size_t end = path.find_first_of(separators, 2);
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000058 return path.substr(0, end);
Michael J. Spencerdffde992010-11-29 22:28:51 +000059 }
60
61 // {/,\}
Michael J. Spencerca3a3392010-12-07 03:57:48 +000062 if (is_separator(path[0]))
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000063 return path.substr(0, 1);
Michael J. Spencerdffde992010-11-29 22:28:51 +000064
65 if (path.startswith(".."))
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000066 return path.substr(0, 2);
Michael J. Spencerdffde992010-11-29 22:28:51 +000067
68 if (path[0] == '.')
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000069 return path.substr(0, 1);
Michael J. Spencerdffde992010-11-29 22:28:51 +000070
71 // * {file,directory}name
Michael J. Spencerca3a3392010-12-07 03:57:48 +000072 size_t end = path.find_first_of(separators, 2);
Benjamin Kramer3ce88c92010-12-17 20:27:37 +000073 return path.substr(0, end);
Michael J. Spencerdffde992010-11-29 22:28:51 +000074 }
Michael J. Spencera42cf732010-11-30 23:28:07 +000075
Benjamin Kramerd53f3c82010-12-17 18:19:06 +000076 size_t filename_pos(StringRef str) {
Michael J. Spencera42cf732010-11-30 23:28:07 +000077 if (str.size() == 2 &&
78 is_separator(str[0]) &&
Michael J. Spencerca3a3392010-12-07 03:57:48 +000079 str[0] == str[1])
Michael J. Spencera42cf732010-11-30 23:28:07 +000080 return 0;
81
82 if (str.size() > 0 && is_separator(str[str.size() - 1]))
83 return str.size() - 1;
84
85 size_t pos = str.find_last_of(separators, str.size() - 1);
86
87#ifdef LLVM_ON_WIN32
88 if (pos == StringRef::npos)
89 pos = str.find_last_of(':', str.size() - 2);
90#endif
91
92 if (pos == StringRef::npos ||
93 (pos == 1 && is_separator(str[0])))
94 return 0;
95
96 return pos + 1;
97 }
98
Benjamin Kramerd53f3c82010-12-17 18:19:06 +000099 size_t root_dir_start(StringRef str) {
Michael J. Spencera42cf732010-11-30 23:28:07 +0000100 // case "c:/"
101#ifdef LLVM_ON_WIN32
102 if (str.size() > 2 &&
103 str[1] == ':' &&
104 is_separator(str[2]))
105 return 2;
106#endif
107
108 // case "//"
109 if (str.size() == 2 &&
110 is_separator(str[0]) &&
111 str[0] == str[1])
112 return StringRef::npos;
113
114 // case "//net"
115 if (str.size() > 3 &&
116 is_separator(str[0]) &&
117 str[0] == str[1] &&
118 !is_separator(str[2])) {
119 return str.find_first_of(separators, 2);
120 }
121
122 // case "/"
123 if (str.size() > 0 && is_separator(str[0]))
124 return 0;
125
126 return StringRef::npos;
127 }
128
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000129 size_t parent_path_end(StringRef path) {
Michael J. Spencera42cf732010-11-30 23:28:07 +0000130 size_t end_pos = filename_pos(path);
131
132 bool filename_was_sep = path.size() > 0 && is_separator(path[end_pos]);
133
134 // Skip separators except for root dir.
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000135 size_t root_dir_pos = root_dir_start(path.substr(0, end_pos));
Michael J. Spencera42cf732010-11-30 23:28:07 +0000136
137 while(end_pos > 0 &&
138 (end_pos - 1) != root_dir_pos &&
139 is_separator(path[end_pos - 1]))
140 --end_pos;
141
142 if (end_pos == 1 && root_dir_pos == 0 && filename_was_sep)
143 return StringRef::npos;
144
145 return end_pos;
146 }
Zhanyong Wan63cc3a82011-02-11 21:24:40 +0000147} // end unnamed namespace
Michael J. Spencerdffde992010-11-29 22:28:51 +0000148
149namespace llvm {
150namespace sys {
151namespace path {
152
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000153const_iterator begin(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000154 const_iterator i;
155 i.Path = path;
156 i.Component = find_first_component(path);
157 i.Position = 0;
158 return i;
159}
160
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000161const_iterator end(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000162 const_iterator i;
163 i.Path = path;
164 i.Position = path.size();
165 return i;
166}
167
Michael J. Spencerdffde992010-11-29 22:28:51 +0000168const_iterator &const_iterator::operator++() {
169 assert(Position < Path.size() && "Tried to increment past end!");
170
171 // Increment Position to past the current component
172 Position += Component.size();
173
174 // Check for end.
175 if (Position == Path.size()) {
176 Component = StringRef();
177 return *this;
178 }
179
180 // Both POSIX and Windows treat paths that begin with exactly two separators
181 // specially.
182 bool was_net = Component.size() > 2 &&
183 is_separator(Component[0]) &&
184 Component[1] == Component[0] &&
185 !is_separator(Component[2]);
186
187 // Handle separators.
188 if (is_separator(Path[Position])) {
189 // Root dir.
190 if (was_net
191#ifdef LLVM_ON_WIN32
192 // c:/
193 || Component.endswith(":")
194#endif
195 ) {
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000196 Component = Path.substr(Position, 1);
Michael J. Spencerdffde992010-11-29 22:28:51 +0000197 return *this;
198 }
199
200 // Skip extra separators.
201 while (Position != Path.size() &&
202 is_separator(Path[Position])) {
203 ++Position;
204 }
205
206 // Treat trailing '/' as a '.'.
207 if (Position == Path.size()) {
208 --Position;
209 Component = ".";
210 return *this;
211 }
212 }
213
214 // Find next component.
215 size_t end_pos = Path.find_first_of(separators, Position);
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000216 Component = Path.slice(Position, end_pos);
Michael J. Spencerdffde992010-11-29 22:28:51 +0000217
218 return *this;
219}
220
Michael J. Spencera42cf732010-11-30 23:28:07 +0000221const_iterator &const_iterator::operator--() {
222 // If we're at the end and the previous char was a '/', return '.'.
223 if (Position == Path.size() &&
224 Path.size() > 1 &&
225 is_separator(Path[Position - 1])
226#ifdef LLVM_ON_WIN32
227 && Path[Position - 2] != ':'
228#endif
229 ) {
230 --Position;
231 Component = ".";
232 return *this;
233 }
234
235 // Skip separators unless it's the root directory.
236 size_t root_dir_pos = root_dir_start(Path);
237 size_t end_pos = Position;
238
239 while(end_pos > 0 &&
240 (end_pos - 1) != root_dir_pos &&
241 is_separator(Path[end_pos - 1]))
242 --end_pos;
243
244 // Find next separator.
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000245 size_t start_pos = filename_pos(Path.substr(0, end_pos));
246 Component = Path.slice(start_pos, end_pos);
Michael J. Spencera42cf732010-11-30 23:28:07 +0000247 Position = start_pos;
248 return *this;
249}
250
Michael J. Spencerdffde992010-11-29 22:28:51 +0000251bool const_iterator::operator==(const const_iterator &RHS) const {
252 return Path.begin() == RHS.Path.begin() &&
253 Position == RHS.Position;
254}
255
256bool const_iterator::operator!=(const const_iterator &RHS) const {
257 return !(*this == RHS);
258}
259
Michael J. Spencera42cf732010-11-30 23:28:07 +0000260ptrdiff_t const_iterator::operator-(const const_iterator &RHS) const {
261 return Position - RHS.Position;
262}
263
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000264const StringRef root_path(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000265 const_iterator b = begin(path),
266 pos = b,
267 e = end(path);
268 if (b != e) {
269 bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
270 bool has_drive =
271#ifdef LLVM_ON_WIN32
272 b->endswith(":");
273#else
274 false;
275#endif
276
277 if (has_net || has_drive) {
278 if ((++pos != e) && is_separator((*pos)[0])) {
279 // {C:/,//net/}, so get the first two components.
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000280 return path.substr(0, b->size() + pos->size());
Michael J. Spencerdffde992010-11-29 22:28:51 +0000281 } else {
282 // just {C:,//net}, return the first component.
Michael J. Spencer50291592010-12-07 17:04:04 +0000283 return *b;
Michael J. Spencerdffde992010-11-29 22:28:51 +0000284 }
285 }
286
287 // POSIX style root directory.
288 if (is_separator((*b)[0])) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000289 return *b;
Michael J. Spencerdffde992010-11-29 22:28:51 +0000290 }
Michael J. Spencerdffde992010-11-29 22:28:51 +0000291 }
292
Michael J. Spencer50291592010-12-07 17:04:04 +0000293 return StringRef();
Michael J. Spencerdffde992010-11-29 22:28:51 +0000294}
295
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000296const StringRef root_name(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000297 const_iterator b = begin(path),
298 e = end(path);
299 if (b != e) {
300 bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
301 bool has_drive =
302#ifdef LLVM_ON_WIN32
303 b->endswith(":");
304#else
305 false;
306#endif
307
308 if (has_net || has_drive) {
309 // just {C:,//net}, return the first component.
Michael J. Spencer50291592010-12-07 17:04:04 +0000310 return *b;
Michael J. Spencerdffde992010-11-29 22:28:51 +0000311 }
312 }
313
314 // No path or no name.
Michael J. Spencer50291592010-12-07 17:04:04 +0000315 return StringRef();
Michael J. Spencerdffde992010-11-29 22:28:51 +0000316}
317
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000318const StringRef root_directory(StringRef path) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000319 const_iterator b = begin(path),
320 pos = b,
321 e = end(path);
322 if (b != e) {
323 bool has_net = b->size() > 2 && is_separator((*b)[0]) && (*b)[1] == (*b)[0];
324 bool has_drive =
325#ifdef LLVM_ON_WIN32
326 b->endswith(":");
327#else
328 false;
329#endif
330
331 if ((has_net || has_drive) &&
332 // {C:,//net}, skip to the next component.
333 (++pos != e) && is_separator((*pos)[0])) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000334 return *pos;
Michael J. Spencerdffde992010-11-29 22:28:51 +0000335 }
336
337 // POSIX style root directory.
338 if (!has_net && is_separator((*b)[0])) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000339 return *b;
Michael J. Spencerdffde992010-11-29 22:28:51 +0000340 }
341 }
342
343 // No path or no root.
Michael J. Spencer50291592010-12-07 17:04:04 +0000344 return StringRef();
Michael J. Spencerdffde992010-11-29 22:28:51 +0000345}
346
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000347const StringRef relative_path(StringRef path) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000348 StringRef root = root_path(path);
Michael J. Spencerd0fff182012-02-29 00:06:24 +0000349 return path.substr(root.size());
Michael J. Spencerdffde992010-11-29 22:28:51 +0000350}
351
Michael J. Spencer936671b2010-12-07 03:57:37 +0000352void append(SmallVectorImpl<char> &path, const Twine &a,
353 const Twine &b,
354 const Twine &c,
355 const Twine &d) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000356 SmallString<32> a_storage;
357 SmallString<32> b_storage;
358 SmallString<32> c_storage;
359 SmallString<32> d_storage;
360
361 SmallVector<StringRef, 4> components;
362 if (!a.isTriviallyEmpty()) components.push_back(a.toStringRef(a_storage));
363 if (!b.isTriviallyEmpty()) components.push_back(b.toStringRef(b_storage));
364 if (!c.isTriviallyEmpty()) components.push_back(c.toStringRef(c_storage));
365 if (!d.isTriviallyEmpty()) components.push_back(d.toStringRef(d_storage));
366
367 for (SmallVectorImpl<StringRef>::const_iterator i = components.begin(),
368 e = components.end();
369 i != e; ++i) {
370 bool path_has_sep = !path.empty() && is_separator(path[path.size() - 1]);
371 bool component_has_sep = !i->empty() && is_separator((*i)[0]);
Michael J. Spencer50291592010-12-07 17:04:04 +0000372 bool is_root_name = has_root_name(*i);
Michael J. Spencerdffde992010-11-29 22:28:51 +0000373
374 if (path_has_sep) {
375 // Strip separators from beginning of component.
376 size_t loc = i->find_first_not_of(separators);
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000377 StringRef c = i->substr(loc);
Michael J. Spencerdffde992010-11-29 22:28:51 +0000378
379 // Append it.
380 path.append(c.begin(), c.end());
381 continue;
382 }
383
Michael J. Spencerf150e762010-12-06 04:28:23 +0000384 if (!component_has_sep && !(path.empty() || is_root_name)) {
Michael J. Spencerdffde992010-11-29 22:28:51 +0000385 // Add a separator.
386 path.push_back(prefered_separator);
387 }
388
389 path.append(i->begin(), i->end());
390 }
Michael J. Spencerdffde992010-11-29 22:28:51 +0000391}
392
Argyrios Kyrtzidis6e31b9b2011-02-15 17:51:19 +0000393void append(SmallVectorImpl<char> &path,
394 const_iterator begin, const_iterator end) {
395 for (; begin != end; ++begin)
396 path::append(path, *begin);
397}
398
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000399const StringRef parent_path(StringRef path) {
Michael J. Spencera42cf732010-11-30 23:28:07 +0000400 size_t end_pos = parent_path_end(path);
401 if (end_pos == StringRef::npos)
Michael J. Spencer50291592010-12-07 17:04:04 +0000402 return StringRef();
Michael J. Spencera42cf732010-11-30 23:28:07 +0000403 else
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000404 return path.substr(0, end_pos);
Michael J. Spencera42cf732010-11-30 23:28:07 +0000405}
406
Michael J. Spencer936671b2010-12-07 03:57:37 +0000407void remove_filename(SmallVectorImpl<char> &path) {
Michael J. Spencerdbfb56b2010-12-01 00:52:28 +0000408 size_t end_pos = parent_path_end(StringRef(path.begin(), path.size()));
Michael J. Spencer936671b2010-12-07 03:57:37 +0000409 if (end_pos != StringRef::npos)
410 path.set_size(end_pos);
Michael J. Spencerdbfb56b2010-12-01 00:52:28 +0000411}
412
Michael J. Spencer50291592010-12-07 17:04:04 +0000413void replace_extension(SmallVectorImpl<char> &path, const Twine &extension) {
Michael J. Spencer52ed8672010-12-01 00:52:55 +0000414 StringRef p(path.begin(), path.size());
415 SmallString<32> ext_storage;
416 StringRef ext = extension.toStringRef(ext_storage);
417
418 // Erase existing extension.
419 size_t pos = p.find_last_of('.');
420 if (pos != StringRef::npos && pos >= filename_pos(p))
421 path.set_size(pos);
422
423 // Append '.' if needed.
424 if (ext.size() > 0 && ext[0] != '.')
425 path.push_back('.');
426
427 // Append extension.
428 path.append(ext.begin(), ext.end());
Michael J. Spencer52ed8672010-12-01 00:52:55 +0000429}
430
Michael J. Spencer936671b2010-12-07 03:57:37 +0000431void native(const Twine &path, SmallVectorImpl<char> &result) {
Michael J. Spencer722d5ad2010-12-01 02:48:27 +0000432 // Clear result.
Michael J. Spencerfbd1bbd2010-12-07 01:23:19 +0000433 result.clear();
Michael J. Spencer722d5ad2010-12-01 02:48:27 +0000434#ifdef LLVM_ON_WIN32
435 SmallString<128> path_storage;
436 StringRef p = path.toStringRef(path_storage);
437 result.reserve(p.size());
438 for (StringRef::const_iterator i = p.begin(),
439 e = p.end();
440 i != e;
441 ++i) {
442 if (*i == '/')
443 result.push_back('\\');
444 else
445 result.push_back(*i);
446 }
447#else
448 path.toVector(result);
449#endif
Michael J. Spencer722d5ad2010-12-01 02:48:27 +0000450}
451
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000452const StringRef filename(StringRef path) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000453 return *(--end(path));
Michael J. Spencera9793552010-12-01 03:18:17 +0000454}
455
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000456const StringRef stem(StringRef path) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000457 StringRef fname = filename(path);
Michael J. Spencer34ab1f62010-12-01 03:18:33 +0000458 size_t pos = fname.find_last_of('.');
459 if (pos == StringRef::npos)
Michael J. Spencer50291592010-12-07 17:04:04 +0000460 return fname;
Michael J. Spencer34ab1f62010-12-01 03:18:33 +0000461 else
462 if ((fname.size() == 1 && fname == ".") ||
463 (fname.size() == 2 && fname == ".."))
Michael J. Spencer50291592010-12-07 17:04:04 +0000464 return fname;
Michael J. Spencer34ab1f62010-12-01 03:18:33 +0000465 else
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000466 return fname.substr(0, pos);
Michael J. Spencer34ab1f62010-12-01 03:18:33 +0000467}
468
Benjamin Kramerd53f3c82010-12-17 18:19:06 +0000469const StringRef extension(StringRef path) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000470 StringRef fname = filename(path);
Michael J. Spencer5265f222010-12-01 03:37:41 +0000471 size_t pos = fname.find_last_of('.');
472 if (pos == StringRef::npos)
Michael J. Spencer50291592010-12-07 17:04:04 +0000473 return StringRef();
Michael J. Spencer5265f222010-12-01 03:37:41 +0000474 else
475 if ((fname.size() == 1 && fname == ".") ||
476 (fname.size() == 2 && fname == ".."))
Michael J. Spencer50291592010-12-07 17:04:04 +0000477 return StringRef();
Michael J. Spencer5265f222010-12-01 03:37:41 +0000478 else
Benjamin Kramer3ce88c92010-12-17 20:27:37 +0000479 return fname.substr(pos);
Michael J. Spencer5265f222010-12-01 03:37:41 +0000480}
481
Zhanyong Wan63cc3a82011-02-11 21:24:40 +0000482bool is_separator(char value) {
483 switch(value) {
484#ifdef LLVM_ON_WIN32
485 case '\\': // fall through
486#endif
487 case '/': return true;
488 default: return false;
489 }
490}
491
Douglas Gregor55cf8152011-09-14 20:27:01 +0000492void system_temp_directory(bool erasedOnReboot, SmallVectorImpl<char> &result) {
493 result.clear();
Michael J. Spencerfaebf112011-12-13 23:16:15 +0000494
Douglas Gregor55cf8152011-09-14 20:27:01 +0000495 // Check whether the temporary directory is specified by an environment
496 // variable.
497 const char *EnvironmentVariable;
498#ifdef LLVM_ON_WIN32
499 EnvironmentVariable = "TEMP";
500#else
501 EnvironmentVariable = "TMPDIR";
502#endif
503 if (char *RequestedDir = getenv(EnvironmentVariable)) {
504 result.append(RequestedDir, RequestedDir + strlen(RequestedDir));
505 return;
506 }
Michael J. Spencerfaebf112011-12-13 23:16:15 +0000507
Douglas Gregor55cf8152011-09-14 20:27:01 +0000508 // Fall back to a system default.
509 const char *DefaultResult;
510#ifdef LLVM_ON_WIN32
511 (void)erasedOnReboot;
Douglas Gregord26d6b62011-09-14 23:21:47 +0000512 DefaultResult = "C:\\TEMP";
Douglas Gregor55cf8152011-09-14 20:27:01 +0000513#else
514 if (erasedOnReboot)
515 DefaultResult = "/tmp";
516 else
517 DefaultResult = "/var/tmp";
518#endif
519 result.append(DefaultResult, DefaultResult + strlen(DefaultResult));
520}
Michael J. Spencerfaebf112011-12-13 23:16:15 +0000521
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000522bool has_root_name(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000523 SmallString<128> path_storage;
524 StringRef p = path.toStringRef(path_storage);
525
Michael J. Spencer50291592010-12-07 17:04:04 +0000526 return !root_name(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000527}
528
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000529bool has_root_directory(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000530 SmallString<128> path_storage;
531 StringRef p = path.toStringRef(path_storage);
532
Michael J. Spencer50291592010-12-07 17:04:04 +0000533 return !root_directory(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000534}
535
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000536bool has_root_path(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000537 SmallString<128> path_storage;
538 StringRef p = path.toStringRef(path_storage);
539
Michael J. Spencer50291592010-12-07 17:04:04 +0000540 return !root_path(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000541}
542
Michael J. Spencer2d484eb2010-12-20 13:30:28 +0000543bool has_relative_path(const Twine &path) {
544 SmallString<128> path_storage;
545 StringRef p = path.toStringRef(path_storage);
546
547 return !relative_path(p).empty();
548}
549
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000550bool has_filename(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000551 SmallString<128> path_storage;
552 StringRef p = path.toStringRef(path_storage);
553
Michael J. Spencer50291592010-12-07 17:04:04 +0000554 return !filename(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000555}
556
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000557bool has_parent_path(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000558 SmallString<128> path_storage;
559 StringRef p = path.toStringRef(path_storage);
560
Michael J. Spencer50291592010-12-07 17:04:04 +0000561 return !parent_path(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000562}
563
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000564bool has_stem(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000565 SmallString<128> path_storage;
566 StringRef p = path.toStringRef(path_storage);
567
Michael J. Spencer50291592010-12-07 17:04:04 +0000568 return !stem(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000569}
570
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000571bool has_extension(const Twine &path) {
Michael J. Spencerae180082010-12-01 06:03:50 +0000572 SmallString<128> path_storage;
573 StringRef p = path.toStringRef(path_storage);
574
Michael J. Spencer50291592010-12-07 17:04:04 +0000575 return !extension(p).empty();
Michael J. Spencerae180082010-12-01 06:03:50 +0000576}
577
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000578bool is_absolute(const Twine &path) {
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000579 SmallString<128> path_storage;
580 StringRef p = path.toStringRef(path_storage);
581
Michael J. Spencer50291592010-12-07 17:04:04 +0000582 bool rootDir = has_root_directory(p),
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000583#ifdef LLVM_ON_WIN32
Michael J. Spencer50291592010-12-07 17:04:04 +0000584 rootName = has_root_name(p);
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000585#else
Michael J. Spencer50291592010-12-07 17:04:04 +0000586 rootName = true;
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000587#endif
588
Michael J. Spencer50291592010-12-07 17:04:04 +0000589 return rootDir && rootName;
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000590}
591
Michael J. Spencer12ccf672010-12-07 18:12:07 +0000592bool is_relative(const Twine &path) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000593 return !is_absolute(path);
Michael J. Spencerce2b68f2010-12-01 06:21:53 +0000594}
595
Michael J. Spencerbee0c382010-12-01 19:32:01 +0000596} // end namespace path
597
598namespace fs {
599
Michael J. Spenceree271d82010-12-07 03:57:17 +0000600error_code make_absolute(SmallVectorImpl<char> &path) {
601 StringRef p(path.data(), path.size());
602
Daniel Dunbard1d72162012-02-29 00:20:37 +0000603 bool rootDirectory = path::has_root_directory(p),
604#ifdef LLVM_ON_WIN32
Daniel Dunbar95fe7b92012-02-29 00:46:46 +0000605 rootName = path::has_root_name(p);
Daniel Dunbard1d72162012-02-29 00:20:37 +0000606#else
607 rootName = true;
608#endif
Michael J. Spenceree271d82010-12-07 03:57:17 +0000609
610 // Already absolute.
611 if (rootName && rootDirectory)
David Blaikie58604cd2012-02-09 19:24:12 +0000612 return error_code::success();
Michael J. Spenceree271d82010-12-07 03:57:17 +0000613
614 // All of the following conditions will need the current directory.
615 SmallString<128> current_dir;
616 if (error_code ec = current_path(current_dir)) return ec;
617
618 // Relative path. Prepend the current directory.
619 if (!rootName && !rootDirectory) {
620 // Append path to the current directory.
Michael J. Spencer936671b2010-12-07 03:57:37 +0000621 path::append(current_dir, p);
Michael J. Spenceree271d82010-12-07 03:57:17 +0000622 // Set path to the result.
623 path.swap(current_dir);
David Blaikie58604cd2012-02-09 19:24:12 +0000624 return error_code::success();
Michael J. Spenceree271d82010-12-07 03:57:17 +0000625 }
626
627 if (!rootName && rootDirectory) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000628 StringRef cdrn = path::root_name(current_dir);
Michael J. Spenceree271d82010-12-07 03:57:17 +0000629 SmallString<128> curDirRootName(cdrn.begin(), cdrn.end());
Michael J. Spencer936671b2010-12-07 03:57:37 +0000630 path::append(curDirRootName, p);
Michael J. Spenceree271d82010-12-07 03:57:17 +0000631 // Set path to the result.
632 path.swap(curDirRootName);
David Blaikie58604cd2012-02-09 19:24:12 +0000633 return error_code::success();
Michael J. Spenceree271d82010-12-07 03:57:17 +0000634 }
635
636 if (rootName && !rootDirectory) {
Michael J. Spencer50291592010-12-07 17:04:04 +0000637 StringRef pRootName = path::root_name(p);
638 StringRef bRootDirectory = path::root_directory(current_dir);
639 StringRef bRelativePath = path::relative_path(current_dir);
640 StringRef pRelativePath = path::relative_path(p);
Michael J. Spenceree271d82010-12-07 03:57:17 +0000641
642 SmallString<128> res;
Michael J. Spencer936671b2010-12-07 03:57:37 +0000643 path::append(res, pRootName, bRootDirectory, bRelativePath, pRelativePath);
Michael J. Spenceree271d82010-12-07 03:57:17 +0000644 path.swap(res);
David Blaikie58604cd2012-02-09 19:24:12 +0000645 return error_code::success();
Michael J. Spenceree271d82010-12-07 03:57:17 +0000646 }
647
648 llvm_unreachable("All rootName and rootDirectory combinations should have "
649 "occurred above!");
650}
651
Michael J. Spencerb83769f2010-12-03 05:42:11 +0000652error_code create_directories(const Twine &path, bool &existed) {
653 SmallString<128> path_storage;
654 StringRef p = path.toStringRef(path_storage);
655
Michael J. Spencer50291592010-12-07 17:04:04 +0000656 StringRef parent = path::parent_path(p);
Michael J. Spencer55f43d62012-03-21 23:09:14 +0000657 if (!parent.empty()) {
658 bool parent_exists;
659 if (error_code ec = fs::exists(parent, parent_exists)) return ec;
Michael J. Spencer50291592010-12-07 17:04:04 +0000660
Michael J. Spencer55f43d62012-03-21 23:09:14 +0000661 if (!parent_exists)
662 if (error_code ec = create_directories(parent, existed)) return ec;
663 }
Michael J. Spencerb83769f2010-12-03 05:42:11 +0000664
665 return create_directory(p, existed);
666}
667
Michael J. Spencer61187dd2010-12-09 17:37:02 +0000668bool exists(file_status status) {
669 return status_known(status) && status.type() != file_type::file_not_found;
670}
671
672bool status_known(file_status s) {
673 return s.type() != file_type::status_error;
674}
675
676bool is_directory(file_status status) {
677 return status.type() == file_type::directory_file;
678}
679
Michael J. Spencer218dc3e2011-01-11 01:21:55 +0000680error_code is_directory(const Twine &path, bool &result) {
681 file_status st;
682 if (error_code ec = status(path, st))
683 return ec;
684 result = is_directory(st);
David Blaikie58604cd2012-02-09 19:24:12 +0000685 return error_code::success();
Michael J. Spencer218dc3e2011-01-11 01:21:55 +0000686}
687
Michael J. Spencer61187dd2010-12-09 17:37:02 +0000688bool is_regular_file(file_status status) {
689 return status.type() == file_type::regular_file;
690}
691
Michael J. Spencer218dc3e2011-01-11 01:21:55 +0000692error_code is_regular_file(const Twine &path, bool &result) {
693 file_status st;
694 if (error_code ec = status(path, st))
695 return ec;
696 result = is_regular_file(st);
David Blaikie58604cd2012-02-09 19:24:12 +0000697 return error_code::success();
Michael J. Spencer218dc3e2011-01-11 01:21:55 +0000698}
699
Michael J. Spencer61187dd2010-12-09 17:37:02 +0000700bool is_symlink(file_status status) {
701 return status.type() == file_type::symlink_file;
702}
703
Michael J. Spencer9df536c2011-01-12 23:55:06 +0000704error_code is_symlink(const Twine &path, bool &result) {
705 file_status st;
706 if (error_code ec = status(path, st))
707 return ec;
708 result = is_symlink(st);
David Blaikie58604cd2012-02-09 19:24:12 +0000709 return error_code::success();
Michael J. Spencer9df536c2011-01-12 23:55:06 +0000710}
711
Michael J. Spencer61187dd2010-12-09 17:37:02 +0000712bool is_other(file_status status) {
713 return exists(status) &&
714 !is_regular_file(status) &&
715 !is_directory(status) &&
716 !is_symlink(status);
717}
718
Benjamin Kramer357b5712011-09-14 01:14:36 +0000719void directory_entry::replace_filename(const Twine &filename, file_status st) {
Michael J. Spencer753cbbb2010-12-06 04:28:42 +0000720 SmallString<128> path(Path.begin(), Path.end());
721 path::remove_filename(path);
722 path::append(path, filename);
723 Path = path.str();
724 Status = st;
Michael J. Spencer753cbbb2010-12-06 04:28:42 +0000725}
726
Michael J. Spencer628467e2010-12-28 01:49:01 +0000727error_code has_magic(const Twine &path, const Twine &magic, bool &result) {
Michael J. Spencer628467e2010-12-28 01:49:01 +0000728 SmallString<32> MagicStorage;
Michael J. Spencerb33594b2011-01-15 18:52:41 +0000729 StringRef Magic = magic.toStringRef(MagicStorage);
730 SmallString<32> Buffer;
Michael J. Spencer628467e2010-12-28 01:49:01 +0000731
Michael J. Spencerb33594b2011-01-15 18:52:41 +0000732 if (error_code ec = get_magic(path, Magic.size(), Buffer)) {
733 if (ec == errc::value_too_large) {
734 // Magic.size() > file_size(Path).
Michael J. Spencer628467e2010-12-28 01:49:01 +0000735 result = false;
David Blaikie58604cd2012-02-09 19:24:12 +0000736 return error_code::success();
Michael J. Spencer628467e2010-12-28 01:49:01 +0000737 }
Michael J. Spencerb33594b2011-01-15 18:52:41 +0000738 return ec;
Michael J. Spencer628467e2010-12-28 01:49:01 +0000739 }
Michael J. Spencer628467e2010-12-28 01:49:01 +0000740
Michael J. Spencerb33594b2011-01-15 18:52:41 +0000741 result = Magic == Buffer;
David Blaikie58604cd2012-02-09 19:24:12 +0000742 return error_code::success();
Michael J. Spencer628467e2010-12-28 01:49:01 +0000743}
744
Michael J. Spencer5b082302011-12-13 23:17:12 +0000745/// @brief Identify the magic in magic.
746file_magic identify_magic(StringRef magic) {
Michael J. Spencerb51c8e92012-06-19 05:29:57 +0000747 if (magic.size() < 4)
748 return file_magic::unknown;
Michael J. Spencer5b082302011-12-13 23:17:12 +0000749 switch ((unsigned char)magic[0]) {
750 case 0xDE: // 0x0B17C0DE = BC wraper
751 if (magic[1] == (char)0xC0 && magic[2] == (char)0x17 &&
752 magic[3] == (char)0x0B)
753 return file_magic::bitcode;
754 break;
755 case 'B':
756 if (magic[1] == 'C' && magic[2] == (char)0xC0 && magic[3] == (char)0xDE)
757 return file_magic::bitcode;
758 break;
759 case '!':
760 if (magic.size() >= 8)
761 if (memcmp(magic.data(),"!<arch>\n",8) == 0)
762 return file_magic::archive;
763 break;
764
765 case '\177':
766 if (magic[1] == 'E' && magic[2] == 'L' && magic[3] == 'F') {
767 if (magic.size() >= 18 && magic[17] == 0)
768 switch (magic[16]) {
769 default: break;
770 case 1: return file_magic::elf_relocatable;
771 case 2: return file_magic::elf_executable;
772 case 3: return file_magic::elf_shared_object;
773 case 4: return file_magic::elf_core;
774 }
775 }
776 break;
777
778 case 0xCA:
779 if (magic[1] == char(0xFE) && magic[2] == char(0xBA) &&
780 magic[3] == char(0xBE)) {
781 // This is complicated by an overlap with Java class files.
782 // See the Mach-O section in /usr/share/file/magic for details.
783 if (magic.size() >= 8 && magic[7] < 43)
784 // FIXME: Universal Binary of any type.
785 return file_magic::macho_dynamically_linked_shared_lib;
786 }
787 break;
788
789 // The two magic numbers for mach-o are:
790 // 0xfeedface - 32-bit mach-o
791 // 0xfeedfacf - 64-bit mach-o
792 case 0xFE:
793 case 0xCE:
794 case 0xCF: {
795 uint16_t type = 0;
796 if (magic[0] == char(0xFE) && magic[1] == char(0xED) &&
797 magic[2] == char(0xFA) &&
798 (magic[3] == char(0xCE) || magic[3] == char(0xCF))) {
799 /* Native endian */
800 if (magic.size() >= 16) type = magic[14] << 8 | magic[15];
801 } else if ((magic[0] == char(0xCE) || magic[0] == char(0xCF)) &&
802 magic[1] == char(0xFA) && magic[2] == char(0xED) &&
803 magic[3] == char(0xFE)) {
804 /* Reverse endian */
805 if (magic.size() >= 14) type = magic[13] << 8 | magic[12];
806 }
807 switch (type) {
808 default: break;
809 case 1: return file_magic::macho_object;
810 case 2: return file_magic::macho_executable;
811 case 3: return file_magic::macho_fixed_virtual_memory_shared_lib;
812 case 4: return file_magic::macho_core;
813 case 5: return file_magic::macho_preload_executabl;
814 case 6: return file_magic::macho_dynamically_linked_shared_lib;
815 case 7: return file_magic::macho_dynamic_linker;
816 case 8: return file_magic::macho_bundle;
817 case 9: return file_magic::macho_dynamic_linker;
818 case 10: return file_magic::macho_dsym_companion;
819 }
820 break;
821 }
822 case 0xF0: // PowerPC Windows
823 case 0x83: // Alpha 32-bit
824 case 0x84: // Alpha 64-bit
825 case 0x66: // MPS R4000 Windows
826 case 0x50: // mc68K
827 case 0x4c: // 80386 Windows
828 if (magic[1] == 0x01)
829 return file_magic::coff_object;
830
831 case 0x90: // PA-RISC Windows
832 case 0x68: // mc68K Windows
833 if (magic[1] == 0x02)
834 return file_magic::coff_object;
835 break;
836
837 case 0x4d: // Possible MS-DOS stub on Windows PE file
838 if (magic[1] == 0x5a) {
839 uint32_t off =
840 *reinterpret_cast<const support::ulittle32_t*>(magic.data() + 0x3c);
841 // PE/COFF file, either EXE or DLL.
842 if (off < magic.size() && memcmp(magic.data() + off, "PE\0\0",4) == 0)
843 return file_magic::pecoff_executable;
844 }
845 break;
846
847 case 0x64: // x86-64 Windows.
848 if (magic[1] == char(0x86))
849 return file_magic::coff_object;
850 break;
851
852 default:
853 break;
854 }
855 return file_magic::unknown;
856}
857
858error_code identify_magic(const Twine &path, file_magic &result) {
Michael J. Spencer28f0ed52011-01-15 20:39:36 +0000859 SmallString<32> Magic;
860 error_code ec = get_magic(path, Magic.capacity(), Magic);
861 if (ec && ec != errc::value_too_large)
862 return ec;
863
Michael J. Spencer5b082302011-12-13 23:17:12 +0000864 result = identify_magic(Magic);
David Blaikie58604cd2012-02-09 19:24:12 +0000865 return error_code::success();
Michael J. Spencer28f0ed52011-01-15 20:39:36 +0000866}
867
Michael J. Spencer7fd682a2011-01-05 16:39:38 +0000868namespace {
869error_code remove_all_r(StringRef path, file_type ft, uint32_t &count) {
870 if (ft == file_type::directory_file) {
871 // This code would be a lot better with exceptions ;/.
872 error_code ec;
Michael J. Spencer1dd2ee72011-12-12 06:03:33 +0000873 directory_iterator i(path, ec);
874 if (ec) return ec;
875 for (directory_iterator e; i != e; i.increment(ec)) {
Michael J. Spencer7fd682a2011-01-05 16:39:38 +0000876 if (ec) return ec;
877 file_status st;
878 if (error_code ec = i->status(st)) return ec;
879 if (error_code ec = remove_all_r(i->path(), st.type(), count)) return ec;
880 }
881 bool obviously_this_exists;
882 if (error_code ec = remove(path, obviously_this_exists)) return ec;
883 assert(obviously_this_exists);
884 ++count; // Include the directory itself in the items removed.
885 } else {
886 bool obviously_this_exists;
887 if (error_code ec = remove(path, obviously_this_exists)) return ec;
888 assert(obviously_this_exists);
889 ++count;
890 }
891
David Blaikie58604cd2012-02-09 19:24:12 +0000892 return error_code::success();
Michael J. Spencer7fd682a2011-01-05 16:39:38 +0000893}
Zhanyong Wan63cc3a82011-02-11 21:24:40 +0000894} // end unnamed namespace
Michael J. Spencer7fd682a2011-01-05 16:39:38 +0000895
896error_code remove_all(const Twine &path, uint32_t &num_removed) {
897 SmallString<128> path_storage;
898 StringRef p = path.toStringRef(path_storage);
899
900 file_status fs;
901 if (error_code ec = status(path, fs))
902 return ec;
903 num_removed = 0;
904 return remove_all_r(p, fs.type(), num_removed);
905}
906
Michael J. Spencer5bcdc7f2011-01-05 16:39:13 +0000907error_code directory_entry::status(file_status &result) const {
908 return fs::status(Path, result);
909}
910
Michael J. Spencerbee0c382010-12-01 19:32:01 +0000911} // end namespace fs
912} // end namespace sys
913} // end namespace llvm
Michael J. Spencerdffde992010-11-29 22:28:51 +0000914
915// Include the truly platform-specific parts.
916#if defined(LLVM_ON_UNIX)
917#include "Unix/PathV2.inc"
918#endif
919#if defined(LLVM_ON_WIN32)
920#include "Windows/PathV2.inc"
921#endif