1 //===- llvm/Support/PathV1.h - Path Operating System Concept ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the llvm::sys::Path class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_PATHV1_H
15 #define LLVM_SUPPORT_PATHV1_H
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/TimeValue.h"
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."
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
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.
52 FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
53 group(999), uniqueID(0), isDir(false), isFile(false) { }
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; }
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.
90 /// @brief An abstraction for operating system paths.
92 /// @name Constructors
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
103 static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
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();
110 /// Return the suffix commonly used on file names that contain an
112 /// @returns The executable file suffix for the current platform.
113 /// @brief Return the executable file suffix.
114 static StringRef GetEXESuffix();
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);
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.
128 Path(const Path &that) : path(that.path) {}
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);
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);
149 /// Makes a copy of \p that to \p this.
151 /// @brief Assignment Operator
152 Path &operator=(const Path &that) {
157 /// Makes a copy of \p that to \p this.
158 /// @param that A StringRef denoting the path
160 /// @brief Assignment Operator
161 Path &operator=(StringRef that);
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;
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); }
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;
182 /// @name Path Accessors
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;
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(); }
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; }
212 /// size - Return the length in bytes of this path name.
213 size_t size() const { return path.size(); }
215 /// empty - Returns true if the path is empty.
216 unsigned empty() const { return path.empty(); }
219 /// @name Disk Accessors
222 /// This function determines if the path name is absolute, as opposed to
224 /// @brief Determine if the path is absolute.
225 LLVM_ATTRIBUTE_DEPRECATED(
226 bool isAbsolute() const,
227 LLVM_PATH_DEPRECATED_MSG(path::is_absolute));
229 /// This function determines if the path name is absolute, as opposed to
231 /// @brief Determine if the path is absolute.
232 LLVM_ATTRIBUTE_DEPRECATED(
233 static bool isAbsolute(const char *NameStart, unsigned NameLen),
234 LLVM_PATH_DEPRECATED_MSG(path::is_absolute));
236 /// This function opens the file associated with the path name provided by
237 /// the Path object and reads its magic number. If the magic number at the
238 /// start of the file matches \p magic, true is returned. In all other
239 /// cases (file not found, file not accessible, etc.) it returns false.
240 /// @returns true if the magic number of the file matches \p magic.
241 /// @brief Determine if file has a specific magic number
242 LLVM_ATTRIBUTE_DEPRECATED(bool hasMagicNumber(StringRef magic) const,
243 LLVM_PATH_DEPRECATED_MSG(fs::has_magic));
245 /// This function retrieves the first \p len bytes of the file associated
246 /// with \p this. These bytes are returned as the "magic number" in the
247 /// \p Magic parameter.
248 /// @returns true if the Path is a file and the magic number is retrieved,
250 /// @brief Get the file's magic number.
251 bool getMagicNumber(std::string& Magic, unsigned len) const;
253 /// This function determines if the path name in the object references an
254 /// archive file by looking at its magic number.
255 /// @returns true if the file starts with the magic number for an archive
257 /// @brief Determine if the path references an archive file.
258 bool isArchive() const;
260 /// This function determines if the path name in the object references an
261 /// LLVM Bitcode file by looking at its magic number.
262 /// @returns true if the file starts with the magic number for LLVM
264 /// @brief Determine if the path references a bitcode file.
265 bool isBitcodeFile() const;
267 /// This function determines if the path name in the object references a
268 /// native Dynamic Library (shared library, shared object) by looking at
269 /// the file's magic number. The Path object must reference a file, not a
271 /// @returns true if the file starts with the magic number for a native
273 /// @brief Determine if the path references a dynamic library.
274 bool isDynamicLibrary() const;
276 /// This function determines if the path name in the object references a
277 /// native object file by looking at it's magic number. The term object
278 /// file is defined as "an organized collection of separate, named
279 /// sequences of binary data." This covers the obvious file formats such
280 /// as COFF and ELF, but it also includes llvm ir bitcode, archives,
281 /// libraries, etc...
282 /// @returns true if the file starts with the magic number for an object
284 /// @brief Determine if the path references an object file.
285 bool isObjectFile() const;
287 /// This function determines if the path name references an existing file
288 /// or directory in the file system.
289 /// @returns true if the pathname references an existing file or
291 /// @brief Determines if the path is a file or directory in
293 LLVM_ATTRIBUTE_DEPRECATED(bool exists() const,
294 LLVM_PATH_DEPRECATED_MSG(fs::exists));
296 /// This function determines if the path name references an
297 /// existing directory.
298 /// @returns true if the pathname references an existing directory.
299 /// @brief Determines if the path is a directory in the file system.
300 LLVM_ATTRIBUTE_DEPRECATED(bool isDirectory() const,
301 LLVM_PATH_DEPRECATED_MSG(fs::is_directory));
303 /// This function determines if the path name references an
304 /// existing symbolic link.
305 /// @returns true if the pathname references an existing symlink.
306 /// @brief Determines if the path is a symlink in the file system.
307 LLVM_ATTRIBUTE_DEPRECATED(bool isSymLink() const,
308 LLVM_PATH_DEPRECATED_MSG(fs::is_symlink));
310 /// This function determines if the path name references a readable file
311 /// or directory in the file system. This function checks for
312 /// the existence and readability (by the current program) of the file
314 /// @returns true if the pathname references a readable file.
315 /// @brief Determines if the path is a readable file or directory
316 /// in the file system.
317 bool canRead() const;
319 /// This function determines if the path name references a writable file
320 /// or directory in the file system. This function checks for the
321 /// existence and writability (by the current program) of the file or
323 /// @returns true if the pathname references a writable file.
324 /// @brief Determines if the path is a writable file or directory
325 /// in the file system.
326 bool canWrite() const;
328 /// This function checks that what we're trying to work only on a regular
329 /// file. Check for things like /dev/null, any block special file, or
330 /// other things that aren't "regular" regular files.
331 /// @returns true if the file is S_ISREG.
332 /// @brief Determines if the file is a regular file
333 bool isRegularFile() const;
335 /// This function determines if the path name references an executable
336 /// file in the file system. This function checks for the existence and
337 /// executability (by the current program) of the file.
338 /// @returns true if the pathname references an executable file.
339 /// @brief Determines if the path is an executable file in the file
341 bool canExecute() const;
343 /// This function builds a list of paths that are the names of the
344 /// files and directories in a directory.
345 /// @returns true if an error occurs, true otherwise
346 /// @brief Build a list of directory's contents.
347 bool getDirectoryContents(
348 std::set<Path> &paths, ///< The resulting list of file & directory names
349 std::string* ErrMsg ///< Optional place to return an error message.
353 /// @name Path Mutators
356 /// The path name is cleared and becomes empty. This is an invalid
357 /// path name but is the *only* invalid path name. This is provided
358 /// so that path objects can be used to indicate the lack of a
359 /// valid path being found.
360 /// @brief Make the path empty.
361 void clear() { path.clear(); }
363 /// This method sets the Path object to \p unverified_path. This can fail
364 /// if the \p unverified_path does not pass the syntactic checks of the
365 /// isValid() method. If verification fails, the Path object remains
366 /// unchanged and false is returned. Otherwise true is returned and the
367 /// Path object takes on the path value of \p unverified_path
368 /// @returns true if the path was set, false otherwise.
369 /// @param unverified_path The path to be set in Path object.
370 /// @brief Set a full path from a StringRef
371 bool set(StringRef unverified_path);
373 /// One path component is removed from the Path. If only one component is
374 /// present in the path, the Path object becomes empty. If the Path object
375 /// is empty, no change is made.
376 /// @returns false if the path component could not be removed.
377 /// @brief Removes the last directory component of the Path.
378 bool eraseComponent();
380 /// The \p component is added to the end of the Path if it is a legal
381 /// name for the operating system. A directory separator will be added if
383 /// @returns false if the path component could not be added.
384 /// @brief Appends one path component to the Path.
385 bool appendComponent(StringRef component);
387 /// A period and the \p suffix are appended to the end of the pathname.
388 /// When the \p suffix is empty, no action is performed.
389 /// @brief Adds a period and the \p suffix to the end of the pathname.
390 void appendSuffix(StringRef suffix);
392 /// The suffix of the filename is erased. The suffix begins with and
393 /// includes the last . character in the filename after the last directory
394 /// separator and extends until the end of the name. If no . character is
395 /// after the last directory separator, then the file name is left
396 /// unchanged (i.e. it was already without a suffix) but the function
398 /// @returns false if there was no suffix to remove, true otherwise.
399 /// @brief Remove the suffix from a path name.
402 /// The current Path name is made unique in the file system. Upon return,
403 /// the Path will have been changed to make a unique file in the file
404 /// system or it will not have been changed if the current path name is
406 /// @throws std::string if an unrecoverable error occurs.
407 /// @brief Make the current path name unique in the file system.
408 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
410 /// The current Path name is made absolute by prepending the
411 /// current working directory if necessary.
412 LLVM_ATTRIBUTE_DEPRECATED(
414 LLVM_PATH_DEPRECATED_MSG(fs::make_absolute));
417 /// @name Disk Mutators
420 /// This method attempts to make the file referenced by the Path object
421 /// available for reading so that the canRead() method will return true.
422 /// @brief Make the file readable;
423 bool makeReadableOnDisk(std::string* ErrMsg = 0);
425 /// This method attempts to make the file referenced by the Path object
426 /// available for writing so that the canWrite() method will return true.
427 /// @brief Make the file writable;
428 bool makeWriteableOnDisk(std::string* ErrMsg = 0);
430 /// This method allows the last modified time stamp and permission bits
431 /// to be set on the disk object referenced by the Path.
432 /// @throws std::string if an error occurs.
433 /// @returns true on error.
434 /// @brief Set the status information.
435 bool setStatusInfoOnDisk(const FileStatus &SI,
436 std::string *ErrStr = 0) const;
438 /// This method attempts to create a directory in the file system with the
439 /// same name as the Path object. The \p create_parents parameter controls
440 /// whether intermediate directories are created or not. if \p
441 /// create_parents is true, then an attempt will be made to create all
442 /// intermediate directories, as needed. If \p create_parents is false,
443 /// then only the final directory component of the Path name will be
444 /// created. The created directory will have no entries.
445 /// @returns true if the directory could not be created, false otherwise
446 /// @brief Create the directory this Path refers to.
447 bool createDirectoryOnDisk(
448 bool create_parents = false, ///< Determines whether non-existent
449 ///< directory components other than the last one (the "parents")
450 ///< are created or not.
451 std::string* ErrMsg = 0 ///< Optional place to put error messages.
454 /// This is like createFile except that it creates a temporary file. A
455 /// unique temporary file name is generated based on the contents of
456 /// \p this before the call. The new name is assigned to \p this and the
457 /// file is created. Note that this will both change the Path object
458 /// *and* create the corresponding file. This function will ensure that
459 /// the newly generated temporary file name is unique in the file system.
460 /// @returns true if the file couldn't be created, false otherwise.
461 /// @brief Create a unique temporary file
462 bool createTemporaryFileOnDisk(
463 bool reuse_current = false, ///< When set to true, this parameter
464 ///< indicates that if the current file name does not exist then
465 ///< it will be used without modification.
466 std::string* ErrMsg = 0 ///< Optional place to put error messages
469 /// This method renames the file referenced by \p this as \p newName. The
470 /// file referenced by \p this must exist. The file referenced by
471 /// \p newName does not need to exist.
472 /// @returns true on error, false otherwise
473 /// @brief Rename one file as another.
474 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
476 /// This method attempts to destroy the file or directory named by the
477 /// last component of the Path. If the Path refers to a directory and the
478 /// \p destroy_contents is false, an attempt will be made to remove just
479 /// the directory (the final Path component). If \p destroy_contents is
480 /// true, an attempt will be made to remove the entire contents of the
481 /// directory, recursively. If the Path refers to a file, the
482 /// \p destroy_contents parameter is ignored.
483 /// @param destroy_contents Indicates whether the contents of a destroyed
484 /// @param Err An optional string to receive an error message.
485 /// directory should also be destroyed (recursively).
486 /// @returns false if the file/directory was destroyed, true on error.
487 /// @brief Removes the file or directory from the filesystem.
488 bool eraseFromDisk(bool destroy_contents = false,
489 std::string *Err = 0) const;
495 // Our win32 implementation relies on this string being mutable.
496 mutable std::string path; ///< Storage for the path name.
502 /// This class is identical to Path class except it allows you to obtain the
503 /// file status of the Path as well. The reason for the distinction is one of
504 /// efficiency. First, the file status requires additional space and the space
505 /// is incorporated directly into PathWithStatus without an additional malloc.
506 /// Second, obtaining status information is an expensive operation on most
507 /// operating systems so we want to be careful and explicit about where we
508 /// allow this operation in LLVM.
509 /// @brief Path with file status class.
510 class PathWithStatus : public Path {
511 /// @name Constructors
514 /// @brief Default constructor
515 PathWithStatus() : Path(), status(), fsIsValid(false) {}
517 /// @brief Copy constructor
518 PathWithStatus(const PathWithStatus &that)
519 : Path(static_cast<const Path&>(that)), status(that.status),
520 fsIsValid(that.fsIsValid) {}
522 /// This constructor allows construction from a Path object
523 /// @brief Path constructor
524 PathWithStatus(const Path &other)
525 : Path(other), status(), fsIsValid(false) {}
527 /// This constructor will accept a char* or std::string as a path. No
528 /// checking is done on this path to determine if it is valid. To
529 /// determine validity of the path, use the isValid method.
530 /// @brief Construct a Path from a string.
531 explicit PathWithStatus(
532 StringRef p ///< The path to assign.
533 ) : Path(p), status(), fsIsValid(false) {}
535 /// This constructor will accept a character range as a path. No checking
536 /// is done on this path to determine if it is valid. To determine
537 /// validity of the path, use the isValid method.
538 /// @brief Construct a Path from a string.
539 explicit PathWithStatus(
540 const char *StrStart, ///< Pointer to the first character of the path
541 unsigned StrLen ///< Length of the path.
542 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
544 /// Makes a copy of \p that to \p this.
546 /// @brief Assignment Operator
547 PathWithStatus &operator=(const PathWithStatus &that) {
548 static_cast<Path&>(*this) = static_cast<const Path&>(that);
549 status = that.status;
550 fsIsValid = that.fsIsValid;
554 /// Makes a copy of \p that to \p this.
556 /// @brief Assignment Operator
557 PathWithStatus &operator=(const Path &that) {
558 static_cast<Path&>(*this) = static_cast<const Path&>(that);
567 /// This function returns status information about the file. The type of
568 /// path (file or directory) is updated to reflect the actual contents
569 /// of the file system.
570 /// @returns 0 on failure, with Error explaining why (if non-zero),
571 /// otherwise returns a pointer to a FileStatus structure on success.
572 /// @brief Get file status.
573 const FileStatus *getFileStatus(
574 bool forceUpdate = false, ///< Force an update from the file system
575 std::string *Error = 0 ///< Optional place to return an error msg.
582 mutable FileStatus status; ///< Status information.
583 mutable bool fsIsValid; ///< Whether we've obtained it or not
588 /// This is the OS-specific path separator: a colon on Unix or a semicolon
590 extern const char PathSeparator;