Debian Codegraph @

media_driver/linux/ult/ult_app/googletest/include/gtest/internal/gtest-filepath.h

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