PageRenderTime 26ms CodeModel.GetById 14ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/thirdparty/breakpad/third_party/protobuf/protobuf/gtest/include/gtest/internal/gtest-filepath.h

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