1 // Copyright 2008, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 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 13 // distribution. 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. 17 // 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. 29 // 30 // Author: keith.ray@gmail.com (Keith Ray) 31 // 32 // Google Test filepath utilities 33 // 34 // This header file declares classes and functions used internally by 35 // Google Test. They are subject to change without notice. 36 // 37 // This file is #included in <gtest/internal/gtest-internal.h>. 38 // Do not include this header file separately! 39 40 #ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ 41 #define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ 42 43 #include "gtest/internal/gtest-string.h" 44 45 namespace testing 46 { 47 namespace internal 48 { 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. 59 60 class GTEST_API_ FilePath 61 { 62 public: FilePath()63 FilePath() : pathname_("") {} FilePath(const FilePath & rhs)64 FilePath(const FilePath& rhs) : pathname_(rhs.pathname_) {} 65 FilePath(const std::string & pathname)66 explicit FilePath(const std::string& pathname) : pathname_(pathname) 67 { 68 Normalize(); 69 } 70 71 FilePath& operator=(const FilePath& rhs) 72 { 73 Set(rhs); 74 return *this; 75 } 76 Set(const FilePath & rhs)77 void Set(const FilePath& rhs) 78 { 79 pathname_ = rhs.pathname_; 80 } 81 string()82 const std::string& string() const { return pathname_; } c_str()83 const char* c_str() const { return pathname_.c_str(); } 84 85 // Returns the current working directory, or "" if unsuccessful. 86 static FilePath GetCurrentDir(); 87 88 // Given directory = "dir", base_name = "test", number = 0, 89 // extension = "xml", returns "dir/test.xml". If number is greater 90 // than zero (e.g., 12), returns "dir/test_12.xml". 91 // On Windows platform, uses \ as the separator rather than /. 92 static FilePath MakeFileName(const FilePath& directory, 93 const FilePath& base_name, 94 int number, 95 const char* extension); 96 97 // Given directory = "dir", relative_path = "test.xml", 98 // returns "dir/test.xml". 99 // On Windows, uses \ as the separator rather than /. 100 static FilePath ConcatPaths(const FilePath& directory, 101 const FilePath& relative_path); 102 103 // Returns a pathname for a file that does not currently exist. The pathname 104 // will be directory/base_name.extension or 105 // directory/base_name_<number>.extension if directory/base_name.extension 106 // already exists. The number will be incremented until a pathname is found 107 // that does not already exist. 108 // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'. 109 // There could be a race condition if two or more processes are calling this 110 // function at the same time -- they could both pick the same filename. 111 static FilePath GenerateUniqueFileName(const FilePath& directory, 112 const FilePath& base_name, 113 const char* extension); 114 115 // Returns true iff the path is "". IsEmpty()116 bool IsEmpty() const { return pathname_.empty(); } 117 118 // If input name has a trailing separator character, removes it and returns 119 // the name, otherwise return the name string unmodified. 120 // On Windows platform, uses \ as the separator, other platforms use /. 121 FilePath RemoveTrailingPathSeparator() const; 122 123 // Returns a copy of the FilePath with the directory part removed. 124 // Example: FilePath("path/to/file").RemoveDirectoryName() returns 125 // FilePath("file"). If there is no directory part ("just_a_file"), it returns 126 // the FilePath unmodified. If there is no file part ("just_a_dir/") it 127 // returns an empty FilePath (""). 128 // On Windows platform, '\' is the path separator, otherwise it is '/'. 129 FilePath RemoveDirectoryName() const; 130 131 // RemoveFileName returns the directory path with the filename removed. 132 // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/". 133 // If the FilePath is "a_file" or "/a_file", RemoveFileName returns 134 // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does 135 // not have a file, like "just/a/dir/", it returns the FilePath unmodified. 136 // On Windows platform, '\' is the path separator, otherwise it is '/'. 137 FilePath RemoveFileName() const; 138 139 // Returns a copy of the FilePath with the case-insensitive extension removed. 140 // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns 141 // FilePath("dir/file"). If a case-insensitive extension is not 142 // found, returns a copy of the original FilePath. 143 FilePath RemoveExtension(const char* extension) const; 144 145 // Creates directories so that path exists. Returns true if successful or if 146 // the directories already exist; returns false if unable to create 147 // directories for any reason. Will also return false if the FilePath does 148 // not represent a directory (that is, it doesn't end with a path separator). 149 bool CreateDirectoriesRecursively() const; 150 151 // Create the directory so that path exists. Returns true if successful or 152 // if the directory already exists; returns false if unable to create the 153 // directory for any reason, including if the parent directory does not 154 // exist. Not named "CreateDirectory" because that's a macro on Windows. 155 bool CreateFolder() const; 156 157 // Returns true if FilePath describes something in the file-system, 158 // either a file, directory, or whatever, and that something exists. 159 bool FileOrDirectoryExists() const; 160 161 // Returns true if pathname describes a directory in the file-system 162 // that exists. 163 bool DirectoryExists() const; 164 165 // Returns true if FilePath ends with a path separator, which indicates that 166 // it is intended to represent a directory. Returns false otherwise. 167 // This does NOT check that a directory (or file) actually exists. 168 bool IsDirectory() const; 169 170 // Returns true if pathname describes a root directory. (Windows has one 171 // root directory per disk drive.) 172 bool IsRootDirectory() const; 173 174 // Returns true if pathname describes an absolute path. 175 bool IsAbsolutePath() const; 176 177 private: 178 // Replaces multiple consecutive separators with a single separator. 179 // For example, "bar///foo" becomes "bar/foo". Does not eliminate other 180 // redundancies that might be in a pathname involving "." or "..". 181 // 182 // A pathname with multiple consecutive separators may occur either through 183 // user error or as a result of some scripts or APIs that generate a pathname 184 // with a trailing separator. On other platforms the same API or script 185 // may NOT generate a pathname with a trailing "/". Then elsewhere that 186 // pathname may have another "/" and pathname components added to it, 187 // without checking for the separator already being there. 188 // The script language and operating system may allow paths like "foo//bar" 189 // but some of the functions in FilePath will not handle that correctly. In 190 // particular, RemoveTrailingPathSeparator() only removes one separator, and 191 // it is called in CreateDirectoriesRecursively() assuming that it will change 192 // a pathname from directory syntax (trailing separator) to filename syntax. 193 // 194 // On Windows this method also replaces the alternate path separator '/' with 195 // the primary path separator '\\', so that for example "bar\\/\\foo" becomes 196 // "bar\\foo". 197 198 void Normalize(); 199 200 // Returns a pointer to the last occurence of a valid path separator in 201 // the FilePath. On Windows, for example, both '/' and '\' are valid path 202 // separators. Returns NULL if no path separator was found. 203 const char* FindLastPathSeparator() const; 204 205 std::string pathname_; 206 }; // class FilePath 207 208 } // namespace internal 209 } // namespace testing 210 211 #endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ 212