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] == ':')
128 void Path::makeAbsolute() {
129 TCHAR FullPath[MAX_PATH + 1] = {0};
130 LPTSTR FilePart = NULL;
132 DWORD RetLength = ::GetFullPathNameA(path.c_str(),
133 sizeof(FullPath)/sizeof(FullPath[0]),
134 FullPath, &FilePart);
136 if (0 == RetLength) {
137 // FIXME: Report the error GetLastError()
138 assert(0 && "Unable to make absolute path!");
139 } else if (RetLength > MAX_PATH) {
140 // FIXME: Report too small buffer (needed RetLength bytes).
141 assert(0 && "Unable to make absolute path!");
148 Path::isAbsolute(const char *NameStart, unsigned NameLen) {
150 // FIXME: This does not handle correctly an absolute path starting from
151 // a drive letter or in UNC format.
157 return NameStart[0] == '/';
159 return NameStart[0] == '/' || (NameStart[1] == ':' && NameStart[2] == '/');
164 Path::isAbsolute() const {
165 // FIXME: This does not handle correctly an absolute path starting from
166 // a drive letter or in UNC format.
167 switch (path.length()) {
172 return path[0] == '/';
174 return path[0] == '/' || (path[1] == ':' && path[2] == '/');
178 static Path *TempDirectory = NULL;
181 Path::GetTemporaryDirectory(std::string* ErrMsg) {
183 return *TempDirectory;
185 char pathname[MAX_PATH];
186 if (!GetTempPath(MAX_PATH, pathname)) {
188 *ErrMsg = "Can't determine temporary directory";
193 result.set(pathname);
195 // Append a subdirectory passed on our process id so multiple LLVMs don't
196 // step on each other's toes.
198 // Mingw's Win32 header files are broken.
199 sprintf(pathname, "LLVM_%u", unsigned(GetCurrentProcessId()));
201 sprintf(pathname, "LLVM_%u", GetCurrentProcessId());
203 result.appendComponent(pathname);
205 // If there's a directory left over from a previous LLVM execution that
206 // happened to have the same process id, get rid of it.
207 result.eraseFromDisk(true);
209 // And finally (re-)create the empty directory.
210 result.createDirectoryOnDisk(false);
211 TempDirectory = new Path(result);
212 return *TempDirectory;
215 // FIXME: the following set of functions don't map to Windows very well.
217 Path::GetRootDirectory() {
224 Path::GetSystemLibraryPaths(std::vector<sys::Path>& Paths) {
225 Paths.push_back(sys::Path("C:/WINDOWS/SYSTEM32"));
226 Paths.push_back(sys::Path("C:/WINDOWS"));
230 Path::GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths) {
231 char * env_var = getenv("LLVM_LIB_SEARCH_PATH");
233 getPathList(env_var,Paths);
238 if (tmpPath.set(LLVM_LIBDIR))
239 if (tmpPath.canRead())
240 Paths.push_back(tmpPath);
243 GetSystemLibraryPaths(Paths);
247 Path::GetLLVMDefaultConfigDir() {
248 // TODO: this isn't going to fly on Windows
249 return Path("/etc/llvm");
253 Path::GetUserHomeDirectory() {
254 // TODO: Typical Windows setup doesn't define HOME.
255 const char* home = getenv("HOME");
258 if (result.set(home))
261 return GetRootDirectory();
265 Path::GetCurrentDirectory() {
266 char pathname[MAX_PATH];
267 ::GetCurrentDirectoryA(MAX_PATH,pathname);
268 return Path(pathname);
271 /// GetMainExecutable - Return the path to the main executable, given the
272 /// value of argv[0] from program startup.
273 Path Path::GetMainExecutable(const char *argv0, void *MainAddr) {
274 char pathname[MAX_PATH];
275 DWORD ret = ::GetModuleFileNameA(NULL, pathname, MAX_PATH);
276 return ret != MAX_PATH ? Path(pathname) : Path();
280 // FIXME: the above set of functions don't map to Windows very well.
284 Path::isRootDirectory() const {
285 size_t len = path.size();
286 return len > 0 && path[len-1] == '/';
289 std::string Path::getDirname() const {
290 return getDirnameCharSep(path, '/');
294 Path::getBasename() const {
295 // Find the last slash
296 size_t slash = path.rfind('/');
297 if (slash == std::string::npos)
302 size_t dot = path.rfind('.');
303 if (dot == std::string::npos || dot < slash)
304 return path.substr(slash);
306 return path.substr(slash, dot - slash);
310 Path::getSuffix() const {
311 // Find the last slash
312 size_t slash = path.rfind('/');
313 if (slash == std::string::npos)
318 size_t dot = path.rfind('.');
319 if (dot == std::string::npos || dot < slash)
320 return std::string();
322 return path.substr(dot + 1);
326 Path::exists() const {
327 DWORD attr = GetFileAttributes(path.c_str());
328 return attr != INVALID_FILE_ATTRIBUTES;
332 Path::isDirectory() const {
333 DWORD attr = GetFileAttributes(path.c_str());
334 return (attr != INVALID_FILE_ATTRIBUTES) &&
335 (attr & FILE_ATTRIBUTE_DIRECTORY);
339 Path::canRead() const {
340 // FIXME: take security attributes into account.
341 DWORD attr = GetFileAttributes(path.c_str());
342 return attr != INVALID_FILE_ATTRIBUTES;
346 Path::canWrite() const {
347 // FIXME: take security attributes into account.
348 DWORD attr = GetFileAttributes(path.c_str());
349 return (attr != INVALID_FILE_ATTRIBUTES) && !(attr & FILE_ATTRIBUTE_READONLY);
353 Path::canExecute() const {
354 // FIXME: take security attributes into account.
355 DWORD attr = GetFileAttributes(path.c_str());
356 return attr != INVALID_FILE_ATTRIBUTES;
360 Path::getLast() const {
361 // Find the last slash
362 size_t pos = path.rfind('/');
364 // Handle the corner cases
365 if (pos == std::string::npos)
368 // If the last character is a slash, we have a root directory
369 if (pos == path.length()-1)
372 // Return everything after the last slash
373 return path.substr(pos+1);
377 PathWithStatus::getFileStatus(bool update, std::string *ErrStr) const {
378 if (!fsIsValid || update) {
379 WIN32_FILE_ATTRIBUTE_DATA fi;
380 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
381 MakeErrMsg(ErrStr, "getStatusInfo():" + std::string(path) +
382 ": Can't get status: ");
386 status.fileSize = fi.nFileSizeHigh;
387 status.fileSize <<= sizeof(fi.nFileSizeHigh)*8;
388 status.fileSize += fi.nFileSizeLow;
390 status.mode = fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY ? 0555 : 0777;
391 status.user = 9999; // Not applicable to Windows, so...
392 status.group = 9999; // Not applicable to Windows, so...
394 // FIXME: this is only unique if the file is accessed by the same file path.
395 // How do we do this for C:\dir\file and ..\dir\file ? Unix has inode
396 // numbers, but the concept doesn't exist in Windows.
398 for (unsigned i = 0; i < path.length(); ++i)
399 status.uniqueID += path[i];
401 __int64 ft = *reinterpret_cast<__int64*>(&fi.ftLastWriteTime);
402 status.modTime.fromWin32Time(ft);
404 status.isDir = fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
410 bool Path::makeReadableOnDisk(std::string* ErrMsg) {
411 // All files are readable on Windows (ignoring security attributes).
415 bool Path::makeWriteableOnDisk(std::string* ErrMsg) {
416 DWORD attr = GetFileAttributes(path.c_str());
418 // If it doesn't exist, we're done.
419 if (attr == INVALID_FILE_ATTRIBUTES)
422 if (attr & FILE_ATTRIBUTE_READONLY) {
423 if (!SetFileAttributes(path.c_str(), attr & ~FILE_ATTRIBUTE_READONLY)) {
424 MakeErrMsg(ErrMsg, std::string(path) + ": Can't make file writable: ");
431 bool Path::makeExecutableOnDisk(std::string* ErrMsg) {
432 // All files are executable on Windows (ignoring security attributes).
437 Path::getDirectoryContents(std::set<Path>& result, std::string* ErrMsg) const {
438 WIN32_FILE_ATTRIBUTE_DATA fi;
439 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi)) {
440 MakeErrMsg(ErrMsg, path + ": can't get status of file");
444 if (!(fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
446 *ErrMsg = path + ": not a directory";
452 std::string searchpath = path;
453 if (path.size() == 0 || searchpath[path.size()-1] == '/')
458 HANDLE h = FindFirstFile(searchpath.c_str(), &fd);
459 if (h == INVALID_HANDLE_VALUE) {
460 if (GetLastError() == ERROR_FILE_NOT_FOUND)
461 return true; // not really an error, now is it?
462 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
467 if (fd.cFileName[0] == '.')
470 aPath.appendComponent(&fd.cFileName[0]);
471 result.insert(aPath);
472 } while (FindNextFile(h, &fd));
474 DWORD err = GetLastError();
476 if (err != ERROR_NO_MORE_FILES) {
478 MakeErrMsg(ErrMsg, path + ": Can't read directory: ");
485 Path::set(const std::string& a_path) {
488 std::string save(path);
490 FlipBackSlashes(path);
499 Path::appendComponent(const std::string& name) {
502 std::string save(path);
504 size_t last = path.size() - 1;
505 if (path[last] != '/')
517 Path::eraseComponent() {
518 size_t slashpos = path.rfind('/',path.size());
519 if (slashpos == path.size() - 1 || slashpos == std::string::npos)
521 std::string save(path);
522 path.erase(slashpos);
531 Path::appendSuffix(const std::string& suffix) {
532 std::string save(path);
543 Path::eraseSuffix() {
544 size_t dotpos = path.rfind('.',path.size());
545 size_t slashpos = path.rfind('/',path.size());
546 if (dotpos != std::string::npos) {
547 if (slashpos == std::string::npos || dotpos > slashpos+1) {
548 std::string save(path);
549 path.erase(dotpos, path.size()-dotpos);
560 inline bool PathMsg(std::string* ErrMsg, const char* pathname, const char*msg) {
562 *ErrMsg = std::string(pathname) + ": " + std::string(msg);
567 Path::createDirectoryOnDisk(bool create_parents, std::string* ErrMsg) {
568 // Get a writeable copy of the path name
569 size_t len = path.length();
570 char *pathname = reinterpret_cast<char *>(_alloca(len+2));
571 path.copy(pathname, len);
574 // Make sure it ends with a slash.
575 if (len == 0 || pathname[len - 1] != '/') {
580 // Determine starting point for initial / search.
581 char *next = pathname;
582 if (pathname[0] == '/' && pathname[1] == '/') {
584 next = strchr(pathname+2, '/');
586 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
589 next = strchr(next+1, '/');
591 return PathMsg(ErrMsg, pathname,"badly formed remote directory");
595 return PathMsg(ErrMsg, pathname, "badly formed remote directory");
598 if (pathname[1] == ':')
599 next += 2; // skip drive letter
601 next++; // skip root directory
604 // If we're supposed to create intermediate directories
605 if (create_parents) {
606 // Loop through the directory components until we're done
608 next = strchr(next, '/');
610 if (!CreateDirectory(pathname, NULL))
611 return MakeErrMsg(ErrMsg,
612 std::string(pathname) + ": Can't create directory: ");
616 // Drop trailing slash.
618 if (!CreateDirectory(pathname, NULL)) {
619 return MakeErrMsg(ErrMsg, std::string(pathname) + ": Can't create directory: ");
626 Path::createFileOnDisk(std::string* ErrMsg) {
628 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
629 FILE_ATTRIBUTE_NORMAL, NULL);
630 if (h == INVALID_HANDLE_VALUE)
631 return MakeErrMsg(ErrMsg, path + ": Can't create file: ");
638 Path::eraseFromDisk(bool remove_contents, std::string *ErrStr) const {
639 WIN32_FILE_ATTRIBUTE_DATA fi;
640 if (!GetFileAttributesEx(path.c_str(), GetFileExInfoStandard, &fi))
643 if (fi.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
644 // If it doesn't exist, we're done.
648 char *pathname = reinterpret_cast<char *>(_alloca(path.length()+3));
649 int lastchar = path.length() - 1 ;
650 path.copy(pathname, lastchar+1);
652 // Make path end with '/*'.
653 if (pathname[lastchar] != '/')
654 pathname[++lastchar] = '/';
655 pathname[lastchar+1] = '*';
656 pathname[lastchar+2] = 0;
658 if (remove_contents) {
660 HANDLE h = FindFirstFile(pathname, &fd);
662 // It's a bad idea to alter the contents of a directory while enumerating
663 // its contents. So build a list of its contents first, then destroy them.
665 if (h != INVALID_HANDLE_VALUE) {
666 std::vector<Path> list;
669 if (strcmp(fd.cFileName, ".") == 0)
671 if (strcmp(fd.cFileName, "..") == 0)
675 aPath.appendComponent(&fd.cFileName[0]);
676 list.push_back(aPath);
677 } while (FindNextFile(h, &fd));
679 DWORD err = GetLastError();
681 if (err != ERROR_NO_MORE_FILES) {
683 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
686 for (std::vector<Path>::iterator I = list.begin(); I != list.end();
689 aPath.eraseFromDisk(true);
692 if (GetLastError() != ERROR_FILE_NOT_FOUND)
693 return MakeErrMsg(ErrStr, path + ": Can't read directory: ");
697 pathname[lastchar] = 0;
698 if (!RemoveDirectory(pathname))
699 return MakeErrMsg(ErrStr,
700 std::string(pathname) + ": Can't destroy directory: ");
703 // Read-only files cannot be deleted on Windows. Must remove the read-only
705 if (fi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
706 if (!SetFileAttributes(path.c_str(),
707 fi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
708 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
711 if (!DeleteFile(path.c_str()))
712 return MakeErrMsg(ErrStr, path + ": Can't destroy file: ");
717 bool Path::getMagicNumber(std::string& Magic, unsigned len) const {
718 assert(len < 1024 && "Request for magic string too long");
719 char* buf = (char*) alloca(1 + len);
721 HANDLE h = CreateFile(path.c_str(),
726 FILE_ATTRIBUTE_NORMAL,
728 if (h == INVALID_HANDLE_VALUE)
732 BOOL ret = ReadFile(h, buf, len, &nRead, NULL);
735 if (!ret || nRead != len)
744 Path::renamePathOnDisk(const Path& newName, std::string* ErrMsg) {
745 if (!MoveFileEx(path.c_str(), newName.c_str(), MOVEFILE_REPLACE_EXISTING))
746 return MakeErrMsg(ErrMsg, "Can't move '" + path + "' to '" + newName.path
752 Path::setStatusInfoOnDisk(const FileStatus &si, std::string *ErrMsg) const {
753 // FIXME: should work on directories also.
758 HANDLE h = CreateFile(path.c_str(),
759 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
760 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
763 FILE_ATTRIBUTE_NORMAL,
765 if (h == INVALID_HANDLE_VALUE)
768 BY_HANDLE_FILE_INFORMATION bhfi;
769 if (!GetFileInformationByHandle(h, &bhfi)) {
770 DWORD err = GetLastError();
773 return MakeErrMsg(ErrMsg, path + ": GetFileInformationByHandle: ");
777 (uint64_t&)ft = si.modTime.toWin32Time();
778 BOOL ret = SetFileTime(h, NULL, &ft, &ft);
779 DWORD err = GetLastError();
783 return MakeErrMsg(ErrMsg, path + ": SetFileTime: ");
786 // Best we can do with Unix permission bits is to interpret the owner
788 if (si.mode & 0200) {
789 if (bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
790 if (!SetFileAttributes(path.c_str(),
791 bhfi.dwFileAttributes & ~FILE_ATTRIBUTE_READONLY))
792 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
795 if (!(bhfi.dwFileAttributes & FILE_ATTRIBUTE_READONLY)) {
796 if (!SetFileAttributes(path.c_str(),
797 bhfi.dwFileAttributes | FILE_ATTRIBUTE_READONLY))
798 return MakeErrMsg(ErrMsg, path + ": SetFileAttributes: ");
806 CopyFile(const sys::Path &Dest, const sys::Path &Src, std::string* ErrMsg) {
807 // Can't use CopyFile macro defined in Windows.h because it would mess up the
808 // above line. We use the expansion it would have in a non-UNICODE build.
809 if (!::CopyFileA(Src.c_str(), Dest.c_str(), false))
810 return MakeErrMsg(ErrMsg, "Can't copy '" + Src.toString() +
811 "' to '" + Dest.toString() + "': ");
816 Path::makeUnique(bool reuse_current, std::string* ErrMsg) {
817 if (reuse_current && !exists())
818 return false; // File doesn't exist already, just use it!
820 // Reserve space for -XXXXXX at the end.
821 char *FNBuffer = (char*) alloca(path.size()+8);
822 unsigned offset = path.size();
823 path.copy(FNBuffer, offset);
825 // Find a numeric suffix that isn't used by an existing file. Assume there
826 // won't be more than 1 million files with the same prefix. Probably a safe
828 static unsigned FCounter = 0;
830 sprintf(FNBuffer+offset, "-%06u", FCounter);
831 if (++FCounter > 999999)
839 Path::createTemporaryFileOnDisk(bool reuse_current, std::string* ErrMsg) {
840 // Make this into a unique file name
841 makeUnique(reuse_current, ErrMsg);
843 // Now go and create it
844 HANDLE h = CreateFile(path.c_str(), GENERIC_WRITE, 0, NULL, CREATE_NEW,
845 FILE_ATTRIBUTE_NORMAL, NULL);
846 if (h == INVALID_HANDLE_VALUE)
847 return MakeErrMsg(ErrMsg, path + ": can't create file");
853 /// MapInFilePages - Not yet implemented on win32.
854 const char *Path::MapInFilePages(int FD, uint64_t FileSize) {
858 /// MapInFilePages - Not yet implemented on win32.
859 void Path::UnMapFilePages(const char *Base, uint64_t FileSize) {
860 assert(0 && "NOT IMPLEMENTED");