1 // Copyright 2008, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "gtest/internal/gtest-filepath.h"
33 #include "gtest/internal/gtest-port.h"
34 #include "gtest/gtest-message.h"
36 #if GTEST_OS_WINDOWS_MOBILE
38 #elif GTEST_OS_WINDOWS
41 #elif GTEST_OS_SYMBIAN
42 // Symbian OpenC has PATH_MAX in sys/syslimits.h
43 # include <sys/syslimits.h>
46 # include <climits> // Some Linux distributions define PATH_MAX here.
47 #endif // GTEST_OS_WINDOWS_MOBILE
49 #include "gtest/internal/gtest-string.h"
52 # define GTEST_PATH_MAX_ _MAX_PATH
53 #elif defined(PATH_MAX)
54 # define GTEST_PATH_MAX_ PATH_MAX
55 #elif defined(_XOPEN_PATH_MAX)
56 # define GTEST_PATH_MAX_ _XOPEN_PATH_MAX
58 # define GTEST_PATH_MAX_ _POSIX_PATH_MAX
59 #endif // GTEST_OS_WINDOWS
65 // On Windows, '\\' is the standard path separator, but many tools and the
66 // Windows API also accept '/' as an alternate path separator. Unless otherwise
67 // noted, a file path can contain either kind of path separators, or a mixture
69 const char kPathSeparator = '\\';
70 const char kAlternatePathSeparator = '/';
71 const char kAlternatePathSeparatorString[] = "/";
72 # if GTEST_OS_WINDOWS_MOBILE
73 // Windows CE doesn't have a current directory. You should not use
74 // the current directory in tests on Windows CE, but this at least
75 // provides a reasonable fallback.
76 const char kCurrentDirectoryString[] = "\\";
77 // Windows CE doesn't define INVALID_FILE_ATTRIBUTES
78 const DWORD kInvalidFileAttributes = 0xffffffff;
80 const char kCurrentDirectoryString[] = ".\\";
81 # endif // GTEST_OS_WINDOWS_MOBILE
83 const char kPathSeparator = '/';
84 const char kCurrentDirectoryString[] = "./";
85 #endif // GTEST_OS_WINDOWS
87 // Returns whether the given character is a valid path separator.
88 static bool IsPathSeparator(char c) {
89 #if GTEST_HAS_ALT_PATH_SEP_
90 return (c == kPathSeparator) || (c == kAlternatePathSeparator);
92 return c == kPathSeparator;
96 // Returns the current working directory, or "" if unsuccessful.
97 FilePath FilePath::GetCurrentDir() {
98 #if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
99 // Windows CE doesn't have a current directory, so we just return
100 // something reasonable.
101 return FilePath(kCurrentDirectoryString);
102 #elif GTEST_OS_WINDOWS
103 char cwd[GTEST_PATH_MAX_ + 1] = { '\0' };
104 return FilePath(_getcwd(cwd, sizeof(cwd)) == NULL ? "" : cwd);
106 char cwd[GTEST_PATH_MAX_ + 1] = { '\0' };
107 char* result = getcwd(cwd, sizeof(cwd));
109 // getcwd will likely fail in NaCl due to the sandbox, so return something
110 // reasonable. The user may have provided a shim implementation for getcwd,
111 // however, so fallback only when failure is detected.
112 return FilePath(result == NULL ? kCurrentDirectoryString : cwd);
113 # endif // GTEST_OS_NACL
114 return FilePath(result == NULL ? "" : cwd);
115 #endif // GTEST_OS_WINDOWS_MOBILE
118 // Returns a copy of the FilePath with the case-insensitive extension removed.
119 // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns
120 // FilePath("dir/file"). If a case-insensitive extension is not
121 // found, returns a copy of the original FilePath.
122 FilePath FilePath::RemoveExtension(const char* extension) const {
123 const std::string dot_extension = std::string(".") + extension;
124 if (String::EndsWithCaseInsensitive(pathname_, dot_extension)) {
125 return FilePath(pathname_.substr(
126 0, pathname_.length() - dot_extension.length()));
131 // Returns a pointer to the last occurrence of a valid path separator in
132 // the FilePath. On Windows, for example, both '/' and '\' are valid path
133 // separators. Returns NULL if no path separator was found.
134 const char* FilePath::FindLastPathSeparator() const {
135 const char* const last_sep = strrchr(c_str(), kPathSeparator);
136 #if GTEST_HAS_ALT_PATH_SEP_
137 const char* const last_alt_sep = strrchr(c_str(), kAlternatePathSeparator);
138 // Comparing two pointers of which only one is NULL is undefined.
139 if (last_alt_sep != NULL &&
140 (last_sep == NULL || last_alt_sep > last_sep)) {
147 // Returns a copy of the FilePath with the directory part removed.
148 // Example: FilePath("path/to/file").RemoveDirectoryName() returns
149 // FilePath("file"). If there is no directory part ("just_a_file"), it returns
150 // the FilePath unmodified. If there is no file part ("just_a_dir/") it
151 // returns an empty FilePath ("").
152 // On Windows platform, '\' is the path separator, otherwise it is '/'.
153 FilePath FilePath::RemoveDirectoryName() const {
154 const char* const last_sep = FindLastPathSeparator();
155 return last_sep ? FilePath(last_sep + 1) : *this;
158 // RemoveFileName returns the directory path with the filename removed.
159 // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/".
160 // If the FilePath is "a_file" or "/a_file", RemoveFileName returns
161 // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does
162 // not have a file, like "just/a/dir/", it returns the FilePath unmodified.
163 // On Windows platform, '\' is the path separator, otherwise it is '/'.
164 FilePath FilePath::RemoveFileName() const {
165 const char* const last_sep = FindLastPathSeparator();
168 dir = std::string(c_str(), last_sep + 1 - c_str());
170 dir = kCurrentDirectoryString;
172 return FilePath(dir);
175 // Helper functions for naming files in a directory for xml output.
177 // Given directory = "dir", base_name = "test", number = 0,
178 // extension = "xml", returns "dir/test.xml". If number is greater
179 // than zero (e.g., 12), returns "dir/test_12.xml".
180 // On Windows platform, uses \ as the separator rather than /.
181 FilePath FilePath::MakeFileName(const FilePath& directory,
182 const FilePath& base_name,
184 const char* extension) {
187 file = base_name.string() + "." + extension;
189 file = base_name.string() + "_" + StreamableToString(number)
192 return ConcatPaths(directory, FilePath(file));
195 // Given directory = "dir", relative_path = "test.xml", returns "dir/test.xml".
196 // On Windows, uses \ as the separator rather than /.
197 FilePath FilePath::ConcatPaths(const FilePath& directory,
198 const FilePath& relative_path) {
199 if (directory.IsEmpty())
200 return relative_path;
201 const FilePath dir(directory.RemoveTrailingPathSeparator());
202 return FilePath(dir.string() + kPathSeparator + relative_path.string());
205 // Returns true if pathname describes something findable in the file-system,
206 // either a file, directory, or whatever.
207 bool FilePath::FileOrDirectoryExists() const {
208 #if GTEST_OS_WINDOWS_MOBILE
209 LPCWSTR unicode = String::AnsiToUtf16(pathname_.c_str());
210 const DWORD attributes = GetFileAttributes(unicode);
212 return attributes != kInvalidFileAttributes;
214 posix::StatStruct file_stat;
215 return posix::Stat(pathname_.c_str(), &file_stat) == 0;
216 #endif // GTEST_OS_WINDOWS_MOBILE
219 // Returns true if pathname describes a directory in the file-system
221 bool FilePath::DirectoryExists() const {
224 // Don't strip off trailing separator if path is a root directory on
225 // Windows (like "C:\\").
226 const FilePath& path(IsRootDirectory() ? *this :
227 RemoveTrailingPathSeparator());
229 const FilePath& path(*this);
232 #if GTEST_OS_WINDOWS_MOBILE
233 LPCWSTR unicode = String::AnsiToUtf16(path.c_str());
234 const DWORD attributes = GetFileAttributes(unicode);
236 if ((attributes != kInvalidFileAttributes) &&
237 (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
241 posix::StatStruct file_stat;
242 result = posix::Stat(path.c_str(), &file_stat) == 0 &&
243 posix::IsDir(file_stat);
244 #endif // GTEST_OS_WINDOWS_MOBILE
249 // Returns true if pathname describes a root directory. (Windows has one
250 // root directory per disk drive.)
251 bool FilePath::IsRootDirectory() const {
253 // FIXME: on Windows a network share like
254 // \\server\share can be a root directory, although it cannot be the
255 // current directory. Handle this properly.
256 return pathname_.length() == 3 && IsAbsolutePath();
258 return pathname_.length() == 1 && IsPathSeparator(pathname_.c_str()[0]);
262 // Returns true if pathname describes an absolute path.
263 bool FilePath::IsAbsolutePath() const {
264 const char* const name = pathname_.c_str();
266 return pathname_.length() >= 3 &&
267 ((name[0] >= 'a' && name[0] <= 'z') ||
268 (name[0] >= 'A' && name[0] <= 'Z')) &&
270 IsPathSeparator(name[2]);
272 return IsPathSeparator(name[0]);
276 // Returns a pathname for a file that does not currently exist. The pathname
277 // will be directory/base_name.extension or
278 // directory/base_name_<number>.extension if directory/base_name.extension
279 // already exists. The number will be incremented until a pathname is found
280 // that does not already exist.
281 // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'.
282 // There could be a race condition if two or more processes are calling this
283 // function at the same time -- they could both pick the same filename.
284 FilePath FilePath::GenerateUniqueFileName(const FilePath& directory,
285 const FilePath& base_name,
286 const char* extension) {
287 FilePath full_pathname;
290 full_pathname.Set(MakeFileName(directory, base_name, number++, extension));
291 } while (full_pathname.FileOrDirectoryExists());
292 return full_pathname;
295 // Returns true if FilePath ends with a path separator, which indicates that
296 // it is intended to represent a directory. Returns false otherwise.
297 // This does NOT check that a directory (or file) actually exists.
298 bool FilePath::IsDirectory() const {
299 return !pathname_.empty() &&
300 IsPathSeparator(pathname_.c_str()[pathname_.length() - 1]);
303 // Create directories so that path exists. Returns true if successful or if
304 // the directories already exist; returns false if unable to create directories
306 bool FilePath::CreateDirectoriesRecursively() const {
307 if (!this->IsDirectory()) {
311 if (pathname_.length() == 0 || this->DirectoryExists()) {
315 const FilePath parent(this->RemoveTrailingPathSeparator().RemoveFileName());
316 return parent.CreateDirectoriesRecursively() && this->CreateFolder();
319 // Create the directory so that path exists. Returns true if successful or
320 // if the directory already exists; returns false if unable to create the
321 // directory for any reason, including if the parent directory does not
322 // exist. Not named "CreateDirectory" because that's a macro on Windows.
323 bool FilePath::CreateFolder() const {
324 #if GTEST_OS_WINDOWS_MOBILE
325 FilePath removed_sep(this->RemoveTrailingPathSeparator());
326 LPCWSTR unicode = String::AnsiToUtf16(removed_sep.c_str());
327 int result = CreateDirectory(unicode, NULL) ? 0 : -1;
329 #elif GTEST_OS_WINDOWS
330 int result = _mkdir(pathname_.c_str());
332 int result = mkdir(pathname_.c_str(), 0777);
333 #endif // GTEST_OS_WINDOWS_MOBILE
336 return this->DirectoryExists(); // An error is OK if the directory exists.
338 return true; // No error.
341 // If input name has a trailing separator character, remove it and return the
342 // name, otherwise return the name string unmodified.
343 // On Windows platform, uses \ as the separator, other platforms use /.
344 FilePath FilePath::RemoveTrailingPathSeparator() const {
346 ? FilePath(pathname_.substr(0, pathname_.length() - 1))
350 // Removes any redundant separators that might be in the pathname.
351 // For example, "bar///foo" becomes "bar/foo". Does not eliminate other
352 // redundancies that might be in a pathname involving "." or "..".
353 // FIXME: handle Windows network shares (e.g. \\server\share).
354 void FilePath::Normalize() {
355 if (pathname_.c_str() == NULL) {
359 const char* src = pathname_.c_str();
360 char* const dest = new char[pathname_.length() + 1];
361 char* dest_ptr = dest;
362 memset(dest_ptr, 0, pathname_.length() + 1);
364 while (*src != '\0') {
366 if (!IsPathSeparator(*src)) {
369 #if GTEST_HAS_ALT_PATH_SEP_
370 if (*dest_ptr == kAlternatePathSeparator) {
371 *dest_ptr = kPathSeparator;
374 while (IsPathSeparator(*src))
384 } // namespace internal
385 } // namespace testing