1 //===- llvm/System/Win32/Path.cpp - Win32 Path Implementation ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 // Modified by Henrik Bach to comply with at least MinGW.
9 // Ported to Win32 by Jeff Cohen.
11 //===----------------------------------------------------------------------===//
13 // This file provides the Win32 specific implementation of the Path class.
15 //===----------------------------------------------------------------------===//
17 //===----------------------------------------------------------------------===//
18 //=== WARNING: Implementation here must contain only generic Win32 code that
19 //=== is guaranteed to work on *all* Win32 variants.
20 //===----------------------------------------------------------------------===//
26 // We need to undo a macro defined in Windows.h, otherwise we won't compile:
28 #undef GetCurrentDirectory
30 // Windows happily accepts either forward or backward slashes, though any path
31 // returned by a Win32 API will have backward slashes. As LLVM code basically
32 // assumes forward slashes are used, backward slashs are converted where they
33 // can be introduced into a path.
35 // Another invariant is that a path ends with a slash if and only if the path
36 // is a root directory. Any other use of a trailing slash is stripped. Unlike
37 // in Unix, Windows has a rather complicated notion of a root path and this
38 // invariant helps simply the code.
40 static void FlipBackSlashes(std::string& s) {
41 for (size_t i = 0; i < s.size(); i++)
48 const char PathSeparator = ';';
50 Path::Path(const std::string& p)
52 FlipBackSlashes(path);
55 Path::Path(const char *StrStart, unsigned StrLen)
56 : path(StrStart, StrLen) {
57 FlipBackSlashes(path);
61 Path::operator=(const std::string &that) {
63 FlipBackSlashes(path);
68 Path::isValid() const {
72 // If there is a colon, it must be the second character, preceded by a letter
73 // and followed by something.
74 size_t len = path.size();
75 size_t pos = path.rfind(':',len);
77 if (pos != std::string::npos) {
78 if (pos != 1 || !isalpha(path[0]) || len < 3)
83 // Look for a UNC path, and if found adjust our notion of the root slash.
84 if (len > 3 && path[0] == '/' && path[1] == '/') {
85 rootslash = path.find('/', 2);
86 if (rootslash == std::string::npos)
90 // Check for illegal characters.
91 if (path.find_first_of("\\<>\"|\001\002\003\004\005\006\007\010\011\012"
92 "\013\014\015\016\017\020\021\022\023\024\025\026"
93 "\027\030\031\032\033\034\035\036\037")
97 // Remove trailing slash, unless it's a root slash.
98 if (len > rootslash+1 && path[len-1] == '/')
101 // Check each component for legality.
102 for (pos = 0; pos < len; ++pos) {
103 // A component may not end in a space.
104 if (path[pos] == ' ') {
105 if (path[pos+1] == '/' || path[pos+1] == '\0')
109 // A component may not end in a period.
110 if (path[pos] == '.') {
111 if (path[pos+1] == '/' || path[pos+1] == '\0') {
112 // Unless it is the pseudo-directory "."...
113 if (pos == 0 || path[pos-1] == '/' || path[pos-1] == ':')
116 if (pos > 0 && path[pos-1] == '.') {
117 if (pos == 1 || path[pos-2] == '/' || path[pos-2] == ':')
129 Path::isAbsolute() const {
130 switch (path.length()) {
135 return path[0] == '/';
137 return path[0] == '/' || (path[1] == ':' && path[2] == '/');
141 static Path *TempDirectory = NULL;
144 Path::GetTemporaryDirectory(std::string* ErrMsg) {
146 return *TempDirectory;
148 char pathname[MAX_PATH];
149 if (!GetTempPath(MAX_PATH, pathname)) {
151 *ErrMsg = "Can't determine temporary directory";
156 result.set(pathname);
158 // Append a subdirectory passed on our process id so multiple LLVMs don't
159 // step on each other's toes.
161 // Mingw's Win32 header files are broken.
162 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
164 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
166 result.appendComponent(pathname);
168 // If there's a directory left over from a previous LLVM execution that
169 // happened to have the same process id, get rid of it.
170 result.eraseFromDisk(true);
172 // And finally (re-)create the empty directory.
173 result.createDirectoryOnDisk(false);
174 TempDirectory = new Path(result);
175 return *TempDirectory;
178 // FIXME: the following set of functions don't map to Windows very well.
180 Path::GetRootDirectory() {
187 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
188 Paths.push_back(sys::Path("C:/WINDOWS/SYSTEM32"));
189 Paths.push_back(sys::Path("C:/WINDOWS"));
193 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
194 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
196 getPathList(env_var,Paths);
201 if (tmpPath.set(LLVM_LIBDIR))
202 if (tmpPath.canRead())
203 Paths.push_back(tmpPath);
206 GetSystemLibraryPaths(Paths);
210 Path::GetLLVMDefaultConfigDir() {
211 // TODO: this isn't going to fly on Windows
212 return Path("/etc/llvm");
216 Path::GetUserHomeDirectory() {
217 // TODO: Typical Windows setup doesn't define HOME.
218 const char* home = getenv("HOME");
221 if (result.set(home))
224 return GetRootDirectory();
228 Path::GetCurrentDirectory() {
229 char pathname[MAX_PATH];
230 ::GetCurrentDirectoryA(MAX_PATH,pathname);
231 return Path(pathname);
234 /// GetMainExecutable - Return the path to the main executable, given the
235 /// value of argv[0] from program startup.
236 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
241 // FIXME: the above set of functions don't map to Windows very well.
245 Path::isRootDirectory() const {
246 size_t len = path.size();
247 return len > 0 && path[len-1] == '/';
250 std::string Path::getDirname() const {
251 return getDirnameCharSep(path, '/');
255 Path::getBasename() const {
256 // Find the last slash
257 size_t slash = path.rfind('/');
258 if (slash == std::string::npos)
263 size_t dot = path.rfind('.');
264 if (dot == std::string::npos || dot < slash)
265 return path.substr(slash);
267 return path.substr(slash, dot - slash);
271 Path::getSuffix() const {
272 // Find the last slash
273 size_t slash = path.rfind('/');
274 if (slash == std::string::npos)
279 size_t dot = path.rfind('.');
280 if (dot == std::string::npos || dot < slash)
281 return std::string();
283 return path.substr(dot + 1);
287 Path::exists() const {
288 DWORD attr = GetFileAttributes(path.c_str());
289 return attr != INVALID_FILE_ATTRIBUTES;
293 Path::isDirectory() const {
294 DWORD attr = GetFileAttributes(path.c_str());
295 return (attr != INVALID_FILE_ATTRIBUTES) &&
296 (attr & FILE_ATTRIBUTE_DIRECTORY);
300 Path::canRead() const {
301 // FIXME: take security attributes into account.
302 DWORD attr = GetFileAttributes(path.c_str());
303 return attr != INVALID_FILE_ATTRIBUTES;
307 Path::canWrite() const {
308 // FIXME: take security attributes into account.
309 DWORD attr = GetFileAttributes(path.c_str());
310 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
314 Path::canExecute() const {
315 // FIXME: take security attributes into account.
316 DWORD attr = GetFileAttributes(path.c_str());
317 return attr != INVALID_FILE_ATTRIBUTES;
321 Path::getLast() const {
322 // Find the last slash
323 size_t pos = path.rfind('/');
325 // Handle the corner cases
326 if (pos == std::string::npos)
329 // If the last character is a slash, we have a root directory
330 if (pos == path.length()-1)
333 // Return everything after the last slash
334 return path.substr(pos+1);
338 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
339 if (!fsIsValid || update) {
340 WIN32_FILE_ATTRIBUTE_DATA fi;
341 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
342 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
343 ": Can't get status: ");
347 status.fileSize = fi.nFileSizeHigh;
348 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
349 status.fileSize += fi.nFileSizeLow;
351 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
352 status.user = 9999; // Not applicable to Windows, so...
353 status.group = 9999; // Not applicable to Windows, so...
355 // FIXME: this is only unique if the file is accessed by the same file path.
356 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
357 // numbers, but the concept doesn't exist in Windows.
359 for (unsigned i = 0; i < path.length(); ++i)
360 status.uniqueID += path[i];
362 __int64 ft = *reinterpret_cast<__int64*>(&fi.ftLastWriteTime);
363 status.modTime.fromWin32Time(ft);
365 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
371 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
372 // All files are readable on Windows (ignoring security attributes).
376 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
377 DWORD attr = GetFileAttributes(path.c_str());
379 // If it doesn't exist, we're done.
380 if (attr == INVALID_FILE_ATTRIBUTES)
383 if (attr & FILE_ATTRIBUTE_READONLY) {
384 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
385 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
392 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
393 // All files are executable on Windows (ignoring security attributes).
398 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
399 WIN32_FILE_ATTRIBUTE_DATA fi;
400 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
401 MakeErrMsg(ErrMsg, path + ": can't get status of file");
405 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
407 *ErrMsg = path + ": not a directory";
413 std::string searchpath = path;
414 if (path.size() == 0 || searchpath[path.size()-1] == '/')
419 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
420 if (h == INVALID_HANDLE_VALUE) {
421 if (GetLastError() == ERROR_FILE_NOT_FOUND)
422 return true; // not really an error, now is it?
423 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
428 if (fd.cFileName[0] == '.')
431 aPath.appendComponent(&fd.cFileName[0]);
432 result.insert(aPath);
433 } while (FindNextFile(h, &fd));
435 DWORD err = GetLastError();
437 if (err != ERROR_NO_MORE_FILES) {
439 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
446 Path::set(const std::string& a_path) {
449 std::string save(path);
451 FlipBackSlashes(path);
460 Path::appendComponent(const std::string& name) {
463 std::string save(path);
465 size_t last = path.size() - 1;
466 if (path[last] != '/')
478 Path::eraseComponent() {
479 size_t slashpos = path.rfind('/',path.size());
480 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
482 std::string save(path);
483 path.erase(slashpos);
492 Path::appendSuffix(const std::string& suffix) {
493 std::string save(path);
504 Path::eraseSuffix() {
505 size_t dotpos = path.rfind('.',path.size());
506 size_t slashpos = path.rfind('/',path.size());
507 if (dotpos != std::string::npos) {
508 if (slashpos == std::string::npos || dotpos > slashpos+1) {
509 std::string save(path);
510 path.erase(dotpos, path.size()-dotpos);
521 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
523 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
528 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
529 // Get a writeable copy of the path name
530 size_t len = path.length();
531 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
532 path.copy(pathname, len);
535 // Make sure it ends with a slash.
536 if (len == 0 || pathname[len - 1] != '/') {
541 // Determine starting point for initial / search.
542 char *next = pathname;
543 if (pathname[0] == '/' && pathname[1] == '/') {
545 next = strchr(pathname+2, '/');
547 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
550 next = strchr(next+1, '/');
552 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
556 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
559 if (pathname[1] == ':')
560 next += 2; // skip drive letter
562 next++; // skip root directory
565 // If we're supposed to create intermediate directories
566 if (create_parents) {
567 // Loop through the directory components until we're done
569 next = strchr(next, '/');
571 if (!CreateDirectory(pathname, NULL))
572 return MakeErrMsg(ErrMsg,
573 std::string(pathname) + ": Can't create directory: ");
577 // Drop trailing slash.
579 if (!CreateDirectory(pathname, NULL)) {
580 return MakeErrMsg(ErrMsg, std::string(pathname) + ": Can't create directory: ");
587 Path::createFileOnDisk(std::string* ErrMsg) {
589 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
590 FILE_ATTRIBUTE_NORMAL, NULL);
591 if (h == INVALID_HANDLE_VALUE)
592 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
599 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
600 WIN32_FILE_ATTRIBUTE_DATA fi;
601 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
604 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
605 // If it doesn't exist, we're done.
609 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
610 int lastchar = path.length() - 1 ;
611 path.copy(pathname, lastchar+1);
613 // Make path end with '/*'.
614 if (pathname[lastchar] != '/')
615 pathname[++lastchar] = '/';
616 pathname[lastchar+1] = '*';
617 pathname[lastchar+2] = 0;
619 if (remove_contents) {
621 HANDLE h = FindFirstFile(pathname, &fd);
623 // It's a bad idea to alter the contents of a directory while enumerating
624 // its contents. So build a list of its contents first, then destroy them.
626 if (h != INVALID_HANDLE_VALUE) {
627 std::vector<Path> list;
630 if (strcmp(fd.cFileName, ".") == 0)
632 if (strcmp(fd.cFileName, "..") == 0)
636 aPath.appendComponent(&fd.cFileName[0]);
637 list.push_back(aPath);
638 } while (FindNextFile(h, &fd));
640 DWORD err = GetLastError();
642 if (err != ERROR_NO_MORE_FILES) {
644 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
647 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
650 aPath.eraseFromDisk(true);
653 if (GetLastError() != ERROR_FILE_NOT_FOUND)
654 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
658 pathname[lastchar] = 0;
659 if (!RemoveDirectory(pathname))
660 return MakeErrMsg(ErrStr,
661 std::string(pathname) + ": Can't destroy directory: ");
664 // Read-only files cannot be deleted on Windows. Must remove the read-only
666 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
667 if (!SetFileAttributes(path.c_str(),
668 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
669 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
672 if (!DeleteFile(path.c_str()))
673 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
678 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
679 assert(len < 1024 && "Request for magic string too long");
680 char* buf = (char*) alloca(1 + len);
682 HANDLE h = CreateFile(path.c_str(),
687 FILE_ATTRIBUTE_NORMAL,
689 if (h == INVALID_HANDLE_VALUE)
693 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
696 if (!ret || nRead != len)
705 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
706 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
707 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
713 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
714 // FIXME: should work on directories also.
719 HANDLE h = CreateFile(path.c_str(),
720 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
721 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
724 FILE_ATTRIBUTE_NORMAL,
726 if (h == INVALID_HANDLE_VALUE)
729 BY_HANDLE_FILE_INFORMATION bhfi;
730 if (!GetFileInformationByHandle(h, &bhfi)) {
731 DWORD err = GetLastError();
734 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
738 (uint64_t&)ft = si.modTime.toWin32Time();
739 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
740 DWORD err = GetLastError();
744 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
747 // Best we can do with Unix permission bits is to interpret the owner
749 if (si.mode & 0200) {
750 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
751 if (!SetFileAttributes(path.c_str(),
752 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
753 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
756 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
757 if (!SetFileAttributes(path.c_str(),
758 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
759 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
767 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
768 // Can't use CopyFile macro defined in Windows.h because it would mess up the
769 // above line. We use the expansion it would have in a non-UNICODE build.
770 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
771 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.toString() +
772 "' to '" + Dest.toString() + "': ");
777 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
778 if (reuse_current && !exists())
779 return false; // File doesn't exist already, just use it!
781 // Reserve space for -XXXXXX at the end.
782 char *FNBuffer = (char*) alloca(path.size()+8);
783 unsigned offset = path.size();
784 path.copy(FNBuffer, offset);
786 // Find a numeric suffix that isn't used by an existing file. Assume there
787 // won't be more than 1 million files with the same prefix. Probably a safe
789 static unsigned FCounter = 0;
791 sprintf(FNBuffer+offset, "-%06u", FCounter);
792 if (++FCounter > 999999)
800 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
801 // Make this into a unique file name
802 makeUnique(reuse_current, ErrMsg);
804 // Now go and create it
805 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
806 FILE_ATTRIBUTE_NORMAL, NULL);
807 if (h == INVALID_HANDLE_VALUE)
808 return MakeErrMsg(ErrMsg, path + ": can't create file");
814 /// MapInFilePages - Not yet implemented on win32.
815 const char *Path::MapInFilePages(int FD, uint64_t FileSize) {
819 /// MapInFilePages - Not yet implemented on win32.
820 void Path::UnMapFilePages(const char *Base, uint64_t FileSize) {
821 assert(0 && "NOT IMPLEMENTED");