4a4816bd8dc7d23b252c17b8086c05c92b700d63
[oota-llvm.git] / include / llvm / Support / PathV1.h
1 //===- llvm/Support/PathV1.h - Path Operating System Concept ----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file declares the llvm::sys::Path class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_SUPPORT_PATHV1_H
15 #define LLVM_SUPPORT_PATHV1_H
16
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/TimeValue.h"
20 #include <set>
21 #include <string>
22 #include <vector>
23
24 #define LLVM_PATH_DEPRECATED_MSG(replacement) \
25   "PathV1 has been deprecated and will be removed as soon as all LLVM and" \
26   " Clang clients have been moved over to PathV2. Please use `" #replacement \
27   "` from PathV2 instead."
28
29 namespace llvm {
30 namespace sys {
31
32   /// This structure provides basic file system information about a file. It
33   /// is patterned after the stat(2) Unix operating system call but made
34   /// platform independent and eliminates many of the unix-specific fields.
35   /// However, to support llvm-ar, the mode, user, and group fields are
36   /// retained. These pertain to unix security and may not have a meaningful
37   /// value on non-Unix platforms. However, the other fields should
38   /// always be applicable on all platforms.  The structure is filled in by
39   /// the PathWithStatus class.
40   /// @brief File status structure
41   class FileStatus {
42   public:
43     uint64_t    fileSize;   ///< Size of the file in bytes
44     TimeValue   modTime;    ///< Time of file's modification
45     uint32_t    mode;       ///< Mode of the file, if applicable
46     uint32_t    user;       ///< User ID of owner, if applicable
47     uint32_t    group;      ///< Group ID of owner, if applicable
48     uint64_t    uniqueID;   ///< A number to uniquely ID this file
49     bool        isDir  : 1; ///< True if this is a directory.
50     bool        isFile : 1; ///< True if this is a file.
51
52     FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
53                    group(999), uniqueID(0), isDir(false), isFile(false) { }
54
55     TimeValue getTimestamp() const { return modTime; }
56     uint64_t getSize() const { return fileSize; }
57     uint32_t getMode() const { return mode; }
58     uint32_t getUser() const { return user; }
59     uint32_t getGroup() const { return group; }
60     uint64_t getUniqueID() const { return uniqueID; }
61   };
62
63   /// This class provides an abstraction for the path to a file or directory
64   /// in the operating system's filesystem and provides various basic operations
65   /// on it.  Note that this class only represents the name of a path to a file
66   /// or directory which may or may not be valid for a given machine's file
67   /// system. The class is patterned after the java.io.File class with various
68   /// extensions and several omissions (not relevant to LLVM).  A Path object
69   /// ensures that the path it encapsulates is syntactically valid for the
70   /// operating system it is running on but does not ensure correctness for
71   /// any particular file system. That is, a syntactically valid path might
72   /// specify path components that do not exist in the file system and using
73   /// such a Path to act on the file system could produce errors. There is one
74   /// invalid Path value which is permitted: the empty path.  The class should
75   /// never allow a syntactically invalid non-empty path name to be assigned.
76   /// Empty paths are required in order to indicate an error result in some
77   /// situations. If the path is empty, the isValid operation will return
78   /// false. All operations will fail if isValid is false. Operations that
79   /// change the path will either return false if it would cause a syntactically
80   /// invalid path name (in which case the Path object is left unchanged) or
81   /// throw an std::string exception indicating the error. The methods are
82   /// grouped into four basic categories: Path Accessors (provide information
83   /// about the path without accessing disk), Disk Accessors (provide
84   /// information about the underlying file or directory), Path Mutators
85   /// (change the path information, not the disk), and Disk Mutators (change
86   /// the disk file/directory referenced by the path). The Disk Mutator methods
87   /// all have the word "disk" embedded in their method name to reinforce the
88   /// notion that the operation modifies the file system.
89   /// @since 1.4
90   /// @brief An abstraction for operating system paths.
91   class Path {
92     /// @name Constructors
93     /// @{
94     public:
95       /// Construct a path to a unique temporary directory that is created in
96       /// a "standard" place for the operating system. The directory is
97       /// guaranteed to be created on exit from this function. If the directory
98       /// cannot be created, the function will throw an exception.
99       /// @returns an invalid path (empty) on error
100       /// @param ErrMsg Optional place for an error message if an error occurs
101       /// @brief Construct a path to an new, unique, existing temporary
102       /// directory.
103       static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
104
105       /// Construct a path to the current directory for the current process.
106       /// @returns The current working directory.
107       /// @brief Returns the current working directory.
108       static Path GetCurrentDirectory();
109
110       /// Return the suffix commonly used on file names that contain an
111       /// executable.
112       /// @returns The executable file suffix for the current platform.
113       /// @brief Return the executable file suffix.
114       static StringRef GetEXESuffix();
115
116       /// GetMainExecutable - Return the path to the main executable, given the
117       /// value of argv[0] from program startup and the address of main itself.
118       /// In extremis, this function may fail and return an empty path.
119       static Path GetMainExecutable(const char *argv0, void *MainAddr);
120
121       /// This is one of the very few ways in which a path can be constructed
122       /// with a syntactically invalid name. The only *legal* invalid name is an
123       /// empty one. Other invalid names are not permitted. Empty paths are
124       /// provided so that they can be used to indicate null or error results in
125       /// other lib/System functionality.
126       /// @brief Construct an empty (and invalid) path.
127       Path() : path() {}
128       Path(const Path &that) : path(that.path) {}
129
130       /// This constructor will accept a char* or std::string as a path. No
131       /// checking is done on this path to determine if it is valid. To
132       /// determine validity of the path, use the isValid method.
133       /// @param p The path to assign.
134       /// @brief Construct a Path from a string.
135       explicit Path(StringRef p);
136
137       /// This constructor will accept a character range as a path.  No checking
138       /// is done on this path to determine if it is valid.  To determine
139       /// validity of the path, use the isValid method.
140       /// @param StrStart A pointer to the first character of the path name
141       /// @param StrLen The length of the path name at StrStart
142       /// @brief Construct a Path from a string.
143       Path(const char *StrStart, unsigned StrLen);
144
145     /// @}
146     /// @name Operators
147     /// @{
148     public:
149       /// Makes a copy of \p that to \p this.
150       /// @returns \p this
151       /// @brief Assignment Operator
152       Path &operator=(const Path &that) {
153         path = that.path;
154         return *this;
155       }
156
157       /// Makes a copy of \p that to \p this.
158       /// @param that A StringRef denoting the path
159       /// @returns \p this
160       /// @brief Assignment Operator
161       Path &operator=(StringRef that);
162
163       /// Compares \p this Path with \p that Path for equality.
164       /// @returns true if \p this and \p that refer to the same thing.
165       /// @brief Equality Operator
166       bool operator==(const Path &that) const;
167
168       /// Compares \p this Path with \p that Path for inequality.
169       /// @returns true if \p this and \p that refer to different things.
170       /// @brief Inequality Operator
171       bool operator!=(const Path &that) const { return !(*this == that); }
172
173       /// Determines if \p this Path is less than \p that Path. This is required
174       /// so that Path objects can be placed into ordered collections (e.g.
175       /// std::map). The comparison is done lexicographically as defined by
176       /// the std::string::compare method.
177       /// @returns true if \p this path is lexicographically less than \p that.
178       /// @brief Less Than Operator
179       bool operator<(const Path& that) const;
180
181     /// @}
182     /// @name Path Accessors
183     /// @{
184     public:
185       /// This function will use an operating system specific algorithm to
186       /// determine if the current value of \p this is a syntactically valid
187       /// path name for the operating system. The path name does not need to
188       /// exist, validity is simply syntactical. Empty paths are always invalid.
189       /// @returns true iff the path name is syntactically legal for the
190       /// host operating system.
191       /// @brief Determine if a path is syntactically valid or not.
192       bool isValid() const;
193
194       /// This function determines if the contents of the path name are empty.
195       /// That is, the path name has a zero length. This does NOT determine if
196       /// if the file is empty. To get the length of the file itself, Use the
197       /// PathWithStatus::getFileStatus() method and then the getSize() method
198       /// on the returned FileStatus object.
199       /// @returns true iff the path is empty.
200       /// @brief Determines if the path name is empty (invalid).
201       bool isEmpty() const { return path.empty(); }
202
203
204
205       /// Obtain a 'C' string for the path name.
206       /// @returns a 'C' string containing the path name.
207       /// @brief Returns the path as a C string.
208       const char *c_str() const { return path.c_str(); }
209       const std::string &str() const { return path; }
210
211
212       /// size - Return the length in bytes of this path name.
213       size_t size() const { return path.size(); }
214
215       /// empty - Returns true if the path is empty.
216       unsigned empty() const { return path.empty(); }
217
218     /// @}
219     /// @name Disk Accessors
220     /// @{
221     public:
222       /// This function opens the file associated with the path name provided by
223       /// the Path object and reads its magic number. If the magic number at the
224       /// start of the file matches \p magic, true is returned. In all other
225       /// cases (file not found, file not accessible, etc.) it returns false.
226       /// @returns true if the magic number of the file matches \p magic.
227       /// @brief Determine if file has a specific magic number
228       LLVM_ATTRIBUTE_DEPRECATED(bool hasMagicNumber(StringRef magic) const,
229         LLVM_PATH_DEPRECATED_MSG(fs::has_magic));
230
231       /// This function retrieves the first \p len bytes of the file associated
232       /// with \p this. These bytes are returned as the "magic number" in the
233       /// \p Magic parameter.
234       /// @returns true if the Path is a file and the magic number is retrieved,
235       /// false otherwise.
236       /// @brief Get the file's magic number.
237       bool getMagicNumber(std::string& Magic, unsigned len) const;
238
239       /// This function determines if the path name in the object references an
240       /// archive file by looking at its magic number.
241       /// @returns true if the file starts with the magic number for an archive
242       /// file.
243       /// @brief Determine if the path references an archive file.
244       bool isArchive() const;
245
246       /// This function determines if the path name in the object references an
247       /// LLVM Bitcode file by looking at its magic number.
248       /// @returns true if the file starts with the magic number for LLVM
249       /// bitcode files.
250       /// @brief Determine if the path references a bitcode file.
251       bool isBitcodeFile() const;
252
253       /// This function determines if the path name in the object references a
254       /// native Dynamic Library (shared library, shared object) by looking at
255       /// the file's magic number. The Path object must reference a file, not a
256       /// directory.
257       /// @returns true if the file starts with the magic number for a native
258       /// shared library.
259       /// @brief Determine if the path references a dynamic library.
260       bool isDynamicLibrary() const;
261
262       /// This function determines if the path name in the object references a
263       /// native object file by looking at it's magic number. The term object
264       /// file is defined as "an organized collection of separate, named
265       /// sequences of binary data." This covers the obvious file formats such
266       /// as COFF and ELF, but it also includes llvm ir bitcode, archives,
267       /// libraries, etc...
268       /// @returns true if the file starts with the magic number for an object
269       /// file.
270       /// @brief Determine if the path references an object file.
271       bool isObjectFile() const;
272
273       /// This function determines if the path name references an existing file
274       /// or directory in the file system.
275       /// @returns true if the pathname references an existing file or
276       /// directory.
277       /// @brief Determines if the path is a file or directory in
278       /// the file system.
279       LLVM_ATTRIBUTE_DEPRECATED(bool exists() const,
280         LLVM_PATH_DEPRECATED_MSG(fs::exists));
281
282       /// This function determines if the path name references an
283       /// existing directory.
284       /// @returns true if the pathname references an existing directory.
285       /// @brief Determines if the path is a directory in the file system.
286       LLVM_ATTRIBUTE_DEPRECATED(bool isDirectory() const,
287         LLVM_PATH_DEPRECATED_MSG(fs::is_directory));
288
289       /// This function determines if the path name references an
290       /// existing symbolic link.
291       /// @returns true if the pathname references an existing symlink.
292       /// @brief Determines if the path is a symlink in the file system.
293       LLVM_ATTRIBUTE_DEPRECATED(bool isSymLink() const,
294         LLVM_PATH_DEPRECATED_MSG(fs::is_symlink));
295
296       /// This function determines if the path name references a readable file
297       /// or directory in the file system. This function checks for
298       /// the existence and readability (by the current program) of the file
299       /// or directory.
300       /// @returns true if the pathname references a readable file.
301       /// @brief Determines if the path is a readable file or directory
302       /// in the file system.
303       bool canRead() const;
304
305       /// This function determines if the path name references a writable file
306       /// or directory in the file system. This function checks for the
307       /// existence and writability (by the current program) of the file or
308       /// directory.
309       /// @returns true if the pathname references a writable file.
310       /// @brief Determines if the path is a writable file or directory
311       /// in the file system.
312       bool canWrite() const;
313
314       /// This function checks that what we're trying to work only on a regular
315       /// file. Check for things like /dev/null, any block special file, or
316       /// other things that aren't "regular" regular files.
317       /// @returns true if the file is S_ISREG.
318       /// @brief Determines if the file is a regular file
319       bool isRegularFile() const;
320
321       /// This function determines if the path name references an executable
322       /// file in the file system. This function checks for the existence and
323       /// executability (by the current program) of the file.
324       /// @returns true if the pathname references an executable file.
325       /// @brief Determines if the path is an executable file in the file
326       /// system.
327       bool canExecute() const;
328
329       /// This function builds a list of paths that are the names of the
330       /// files and directories in a directory.
331       /// @returns true if an error occurs, true otherwise
332       /// @brief Build a list of directory's contents.
333       bool getDirectoryContents(
334         std::set<Path> &paths, ///< The resulting list of file & directory names
335         std::string* ErrMsg    ///< Optional place to return an error message.
336       ) const;
337
338     /// @}
339     /// @name Path Mutators
340     /// @{
341     public:
342       /// The path name is cleared and becomes empty. This is an invalid
343       /// path name but is the *only* invalid path name. This is provided
344       /// so that path objects can be used to indicate the lack of a
345       /// valid path being found.
346       /// @brief Make the path empty.
347       void clear() { path.clear(); }
348
349       /// This method sets the Path object to \p unverified_path. This can fail
350       /// if the \p unverified_path does not pass the syntactic checks of the
351       /// isValid() method. If verification fails, the Path object remains
352       /// unchanged and false is returned. Otherwise true is returned and the
353       /// Path object takes on the path value of \p unverified_path
354       /// @returns true if the path was set, false otherwise.
355       /// @param unverified_path The path to be set in Path object.
356       /// @brief Set a full path from a StringRef
357       bool set(StringRef unverified_path);
358
359       /// One path component is removed from the Path. If only one component is
360       /// present in the path, the Path object becomes empty. If the Path object
361       /// is empty, no change is made.
362       /// @returns false if the path component could not be removed.
363       /// @brief Removes the last directory component of the Path.
364       bool eraseComponent();
365
366       /// The \p component is added to the end of the Path if it is a legal
367       /// name for the operating system. A directory separator will be added if
368       /// needed.
369       /// @returns false if the path component could not be added.
370       /// @brief Appends one path component to the Path.
371       bool appendComponent(StringRef component);
372
373       /// A period and the \p suffix are appended to the end of the pathname.
374       /// When the \p suffix is empty, no action is performed.
375       /// @brief Adds a period and the \p suffix to the end of the pathname.
376       void appendSuffix(StringRef suffix);
377
378       /// The suffix of the filename is erased. The suffix begins with and
379       /// includes the last . character in the filename after the last directory
380       /// separator and extends until the end of the name. If no . character is
381       /// after the last directory separator, then the file name is left
382       /// unchanged (i.e. it was already without a suffix) but the function
383       /// returns false.
384       /// @returns false if there was no suffix to remove, true otherwise.
385       /// @brief Remove the suffix from a path name.
386       bool eraseSuffix();
387
388       /// The current Path name is made unique in the file system. Upon return,
389       /// the Path will have been changed to make a unique file in the file
390       /// system or it will not have been changed if the current path name is
391       /// already unique.
392       /// @throws std::string if an unrecoverable error occurs.
393       /// @brief Make the current path name unique in the file system.
394       bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
395
396       /// The current Path name is made absolute by prepending the
397       /// current working directory if necessary.
398       LLVM_ATTRIBUTE_DEPRECATED(
399         void makeAbsolute(),
400         LLVM_PATH_DEPRECATED_MSG(fs::make_absolute));
401
402     /// @}
403     /// @name Disk Mutators
404     /// @{
405     public:
406       /// This method attempts to make the file referenced by the Path object
407       /// available for reading so that the canRead() method will return true.
408       /// @brief Make the file readable;
409       bool makeReadableOnDisk(std::string* ErrMsg = 0);
410
411       /// This method attempts to make the file referenced by the Path object
412       /// available for writing so that the canWrite() method will return true.
413       /// @brief Make the file writable;
414       bool makeWriteableOnDisk(std::string* ErrMsg = 0);
415
416       /// This method allows the last modified time stamp and permission bits
417       /// to be set on the disk object referenced by the Path.
418       /// @throws std::string if an error occurs.
419       /// @returns true on error.
420       /// @brief Set the status information.
421       bool setStatusInfoOnDisk(const FileStatus &SI,
422                                std::string *ErrStr = 0) const;
423
424       /// This method attempts to create a directory in the file system with the
425       /// same name as the Path object. The \p create_parents parameter controls
426       /// whether intermediate directories are created or not. if \p
427       /// create_parents is true, then an attempt will be made to create all
428       /// intermediate directories, as needed. If \p create_parents is false,
429       /// then only the final directory component of the Path name will be
430       /// created. The created directory will have no entries.
431       /// @returns true if the directory could not be created, false otherwise
432       /// @brief Create the directory this Path refers to.
433       bool createDirectoryOnDisk(
434         bool create_parents = false, ///<  Determines whether non-existent
435            ///< directory components other than the last one (the "parents")
436            ///< are created or not.
437         std::string* ErrMsg = 0 ///< Optional place to put error messages.
438       );
439
440       /// This is like createFile except that it creates a temporary file. A
441       /// unique temporary file name is generated based on the contents of
442       /// \p this before the call. The new name is assigned to \p this and the
443       /// file is created.  Note that this will both change the Path object
444       /// *and* create the corresponding file. This function will ensure that
445       /// the newly generated temporary file name is unique in the file system.
446       /// @returns true if the file couldn't be created, false otherwise.
447       /// @brief Create a unique temporary file
448       bool createTemporaryFileOnDisk(
449         bool reuse_current = false, ///< When set to true, this parameter
450           ///< indicates that if the current file name does not exist then
451           ///< it will be used without modification.
452         std::string* ErrMsg = 0 ///< Optional place to put error messages
453       );
454
455       /// This method renames the file referenced by \p this as \p newName. The
456       /// file referenced by \p this must exist. The file referenced by
457       /// \p newName does not need to exist.
458       /// @returns true on error, false otherwise
459       /// @brief Rename one file as another.
460       bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
461
462       /// This method attempts to destroy the file or directory named by the
463       /// last component of the Path. If the Path refers to a directory and the
464       /// \p destroy_contents is false, an attempt will be made to remove just
465       /// the directory (the final Path component). If \p destroy_contents is
466       /// true, an attempt will be made to remove the entire contents of the
467       /// directory, recursively. If the Path refers to a file, the
468       /// \p destroy_contents parameter is ignored.
469       /// @param destroy_contents Indicates whether the contents of a destroyed
470       /// @param Err An optional string to receive an error message.
471       /// directory should also be destroyed (recursively).
472       /// @returns false if the file/directory was destroyed, true on error.
473       /// @brief Removes the file or directory from the filesystem.
474       bool eraseFromDisk(bool destroy_contents = false,
475                          std::string *Err = 0) const;
476
477     /// @}
478     /// @name Data
479     /// @{
480     protected:
481       // Our win32 implementation relies on this string being mutable.
482       mutable std::string path;   ///< Storage for the path name.
483
484
485     /// @}
486   };
487
488   /// This class is identical to Path class except it allows you to obtain the
489   /// file status of the Path as well. The reason for the distinction is one of
490   /// efficiency. First, the file status requires additional space and the space
491   /// is incorporated directly into PathWithStatus without an additional malloc.
492   /// Second, obtaining status information is an expensive operation on most
493   /// operating systems so we want to be careful and explicit about where we
494   /// allow this operation in LLVM.
495   /// @brief Path with file status class.
496   class PathWithStatus : public Path {
497     /// @name Constructors
498     /// @{
499     public:
500       /// @brief Default constructor
501       PathWithStatus() : Path(), status(), fsIsValid(false) {}
502
503       /// @brief Copy constructor
504       PathWithStatus(const PathWithStatus &that)
505         : Path(static_cast<const Path&>(that)), status(that.status),
506            fsIsValid(that.fsIsValid) {}
507
508       /// This constructor allows construction from a Path object
509       /// @brief Path constructor
510       PathWithStatus(const Path &other)
511         : Path(other), status(), fsIsValid(false) {}
512
513       /// This constructor will accept a char* or std::string as a path. No
514       /// checking is done on this path to determine if it is valid. To
515       /// determine validity of the path, use the isValid method.
516       /// @brief Construct a Path from a string.
517       explicit PathWithStatus(
518         StringRef p ///< The path to assign.
519       ) : Path(p), status(), fsIsValid(false) {}
520
521       /// This constructor will accept a character range as a path.  No checking
522       /// is done on this path to determine if it is valid.  To determine
523       /// validity of the path, use the isValid method.
524       /// @brief Construct a Path from a string.
525       explicit PathWithStatus(
526         const char *StrStart,  ///< Pointer to the first character of the path
527         unsigned StrLen        ///< Length of the path.
528       ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
529
530       /// Makes a copy of \p that to \p this.
531       /// @returns \p this
532       /// @brief Assignment Operator
533       PathWithStatus &operator=(const PathWithStatus &that) {
534         static_cast<Path&>(*this) = static_cast<const Path&>(that);
535         status = that.status;
536         fsIsValid = that.fsIsValid;
537         return *this;
538       }
539
540       /// Makes a copy of \p that to \p this.
541       /// @returns \p this
542       /// @brief Assignment Operator
543       PathWithStatus &operator=(const Path &that) {
544         static_cast<Path&>(*this) = static_cast<const Path&>(that);
545         fsIsValid = false;
546         return *this;
547       }
548
549     /// @}
550     /// @name Methods
551     /// @{
552     public:
553       /// This function returns status information about the file. The type of
554       /// path (file or directory) is updated to reflect the actual contents
555       /// of the file system.
556       /// @returns 0 on failure, with Error explaining why (if non-zero),
557       /// otherwise returns a pointer to a FileStatus structure on success.
558       /// @brief Get file status.
559       const FileStatus *getFileStatus(
560         bool forceUpdate = false, ///< Force an update from the file system
561         std::string *Error = 0    ///< Optional place to return an error msg.
562       ) const;
563
564     /// @}
565     /// @name Data
566     /// @{
567     private:
568       mutable FileStatus status; ///< Status information.
569       mutable bool fsIsValid;    ///< Whether we've obtained it or not
570
571     /// @}
572   };
573
574   /// This is the OS-specific path separator: a colon on Unix or a semicolon
575   /// on Windows.
576   extern const char PathSeparator;
577 }
578
579 }
580
581 #endif