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 // Google Test filepath utilities
32 // This header file declares classes and functions used internally by
33 // Google Test. They are subject to change without notice.
35 // This file is #included in gtest/internal/gtest-internal.h.
36 // Do not include this header file separately!
38 #ifndef GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_
39 #define GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_
41 #include "gtest/internal/gtest-string.h"
43 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4251 \
44 /* class A needs to have dll-interface to be used by clients of class B */)
49 // FilePath - a class for file and directory pathname manipulation which
50 // handles platform-specific conventions (like the pathname separator).
51 // Used for helper functions for naming files in a directory for xml output.
52 // Except for Set methods, all methods are const or static, which provides an
53 // "immutable value object" -- useful for peace of mind.
54 // A FilePath with a value ending in a path separator ("like/this/") represents
55 // a directory, otherwise it is assumed to represent a file. In either case,
56 // it may or may not represent an actual file or directory in the file system.
57 // Names are NOT checked for syntax correctness -- no checking for illegal
58 // characters, malformed paths, etc.
60 class GTEST_API_ FilePath {
62 FilePath() : pathname_("") { }
63 FilePath(const FilePath& rhs) : pathname_(rhs.pathname_) { }
65 explicit FilePath(const std::string& pathname) : pathname_(pathname) {
69 FilePath& operator=(const FilePath& rhs) {
74 void Set(const FilePath& rhs) {
75 pathname_ = rhs.pathname_;
78 const std::string& string() const { return pathname_; }
79 const char* c_str() const { return pathname_.c_str(); }
81 // Returns the current working directory, or "" if unsuccessful.
82 static FilePath GetCurrentDir();
84 // Given directory = "dir", base_name = "test", number = 0,
85 // extension = "xml", returns "dir/test.xml". If number is greater
86 // than zero (e.g., 12), returns "dir/test_12.xml".
87 // On Windows platform, uses \ as the separator rather than /.
88 static FilePath MakeFileName(const FilePath& directory,
89 const FilePath& base_name,
91 const char* extension);
93 // Given directory = "dir", relative_path = "test.xml",
94 // returns "dir/test.xml".
95 // On Windows, uses \ as the separator rather than /.
96 static FilePath ConcatPaths(const FilePath& directory,
97 const FilePath& relative_path);
99 // Returns a pathname for a file that does not currently exist. The pathname
100 // will be directory/base_name.extension or
101 // directory/base_name_<number>.extension if directory/base_name.extension
102 // already exists. The number will be incremented until a pathname is found
103 // that does not already exist.
104 // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'.
105 // There could be a race condition if two or more processes are calling this
106 // function at the same time -- they could both pick the same filename.
107 static FilePath GenerateUniqueFileName(const FilePath& directory,
108 const FilePath& base_name,
109 const char* extension);
111 // Returns true if and only if the path is "".
112 bool IsEmpty() const { return pathname_.empty(); }
114 // If input name has a trailing separator character, removes it and returns
115 // the name, otherwise return the name string unmodified.
116 // On Windows platform, uses \ as the separator, other platforms use /.
117 FilePath RemoveTrailingPathSeparator() const;
119 // Returns a copy of the FilePath with the directory part removed.
120 // Example: FilePath("path/to/file").RemoveDirectoryName() returns
121 // FilePath("file"). If there is no directory part ("just_a_file"), it returns
122 // the FilePath unmodified. If there is no file part ("just_a_dir/") it
123 // returns an empty FilePath ("").
124 // On Windows platform, '\' is the path separator, otherwise it is '/'.
125 FilePath RemoveDirectoryName() const;
127 // RemoveFileName returns the directory path with the filename removed.
128 // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/".
129 // If the FilePath is "a_file" or "/a_file", RemoveFileName returns
130 // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does
131 // not have a file, like "just/a/dir/", it returns the FilePath unmodified.
132 // On Windows platform, '\' is the path separator, otherwise it is '/'.
133 FilePath RemoveFileName() const;
135 // Returns a copy of the FilePath with the case-insensitive extension removed.
136 // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns
137 // FilePath("dir/file"). If a case-insensitive extension is not
138 // found, returns a copy of the original FilePath.
139 FilePath RemoveExtension(const char* extension) const;
141 // Creates directories so that path exists. Returns true if successful or if
142 // the directories already exist; returns false if unable to create
143 // directories for any reason. Will also return false if the FilePath does
144 // not represent a directory (that is, it doesn't end with a path separator).
145 bool CreateDirectoriesRecursively() const;
147 // Create the directory so that path exists. Returns true if successful or
148 // if the directory already exists; returns false if unable to create the
149 // directory for any reason, including if the parent directory does not
150 // exist. Not named "CreateDirectory" because that's a macro on Windows.
151 bool CreateFolder() const;
153 // Returns true if FilePath describes something in the file-system,
154 // either a file, directory, or whatever, and that something exists.
155 bool FileOrDirectoryExists() const;
157 // Returns true if pathname describes a directory in the file-system
159 bool DirectoryExists() const;
161 // Returns true if FilePath ends with a path separator, which indicates that
162 // it is intended to represent a directory. Returns false otherwise.
163 // This does NOT check that a directory (or file) actually exists.
164 bool IsDirectory() const;
166 // Returns true if pathname describes a root directory. (Windows has one
167 // root directory per disk drive.)
168 bool IsRootDirectory() const;
170 // Returns true if pathname describes an absolute path.
171 bool IsAbsolutePath() const;
174 // Replaces multiple consecutive separators with a single separator.
175 // For example, "bar///foo" becomes "bar/foo". Does not eliminate other
176 // redundancies that might be in a pathname involving "." or "..".
178 // A pathname with multiple consecutive separators may occur either through
179 // user error or as a result of some scripts or APIs that generate a pathname
180 // with a trailing separator. On other platforms the same API or script
181 // may NOT generate a pathname with a trailing "/". Then elsewhere that
182 // pathname may have another "/" and pathname components added to it,
183 // without checking for the separator already being there.
184 // The script language and operating system may allow paths like "foo//bar"
185 // but some of the functions in FilePath will not handle that correctly. In
186 // particular, RemoveTrailingPathSeparator() only removes one separator, and
187 // it is called in CreateDirectoriesRecursively() assuming that it will change
188 // a pathname from directory syntax (trailing separator) to filename syntax.
190 // On Windows this method also replaces the alternate path separator '/' with
191 // the primary path separator '\\', so that for example "bar\\/\\foo" becomes
196 // Returns a pointer to the last occurrence of a valid path separator in
197 // the FilePath. On Windows, for example, both '/' and '\' are valid path
198 // separators. Returns NULL if no path separator was found.
199 const char* FindLastPathSeparator() const;
201 std::string pathname_;
204 } // namespace internal
205 } // namespace testing
207 GTEST_DISABLE_MSC_WARNINGS_POP_() // 4251
209 #endif // GOOGLETEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_