1 //===- llvm/System/Path.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_SYSTEM_PATH_H
15 #define LLVM_SYSTEM_PATH_H
17 #include "llvm/System/TimeValue.h"
18 #include "llvm/Support/raw_ostream.h"
27 /// This structure provides basic file system information about a file. It
28 /// is patterned after the stat(2) Unix operating system call but made
29 /// platform independent and eliminates many of the unix-specific fields.
30 /// However, to support llvm-ar, the mode, user, and group fields are
31 /// retained. These pertain to unix security and may not have a meaningful
32 /// value on non-Unix platforms. However, the other fields fields should
33 /// always be applicable on all platforms. The structure is filled in by
34 /// the PathWithStatus class.
35 /// @brief File status structure
38 uint64_t fileSize; ///< Size of the file in bytes
39 TimeValue modTime; ///< Time of file's modification
40 uint32_t mode; ///< Mode of the file, if applicable
41 uint32_t user; ///< User ID of owner, if applicable
42 uint32_t group; ///< Group ID of owner, if applicable
43 uint64_t uniqueID; ///< A number to uniquely ID this file
44 bool isDir : 1; ///< True if this is a directory.
45 bool isFile : 1; ///< True if this is a file.
47 FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
48 group(999), uniqueID(0), isDir(false), isFile(false) { }
50 TimeValue getTimestamp() const { return modTime; }
51 uint64_t getSize() const { return fileSize; }
52 uint32_t getMode() const { return mode; }
53 uint32_t getUser() const { return user; }
54 uint32_t getGroup() const { return group; }
55 uint64_t getUniqueID() const { return uniqueID; }
58 /// This class provides an abstraction for the path to a file or directory
59 /// in the operating system's filesystem and provides various basic operations
60 /// on it. Note that this class only represents the name of a path to a file
61 /// or directory which may or may not be valid for a given machine's file
62 /// system. The class is patterned after the java.io.File class with various
63 /// extensions and several omissions (not relevant to LLVM). A Path object
64 /// ensures that the path it encapsulates is syntactically valid for the
65 /// operating system it is running on but does not ensure correctness for
66 /// any particular file system. That is, a syntactically valid path might
67 /// specify path components that do not exist in the file system and using
68 /// such a Path to act on the file system could produce errors. There is one
69 /// invalid Path value which is permitted: the empty path. The class should
70 /// never allow a syntactically invalid non-empty path name to be assigned.
71 /// Empty paths are required in order to indicate an error result in some
72 /// situations. If the path is empty, the isValid operation will return
73 /// false. All operations will fail if isValid is false. Operations that
74 /// change the path will either return false if it would cause a syntactically
75 /// invalid path name (in which case the Path object is left unchanged) or
76 /// throw an std::string exception indicating the error. The methods are
77 /// grouped into four basic categories: Path Accessors (provide information
78 /// about the path without accessing disk), Disk Accessors (provide
79 /// information about the underlying file or directory), Path Mutators
80 /// (change the path information, not the disk), and Disk Mutators (change
81 /// the disk file/directory referenced by the path). The Disk Mutator methods
82 /// all have the word "disk" embedded in their method name to reinforce the
83 /// notion that the operation modifies the file system.
85 /// @brief An abstraction for operating system paths.
87 /// @name Constructors
90 /// Construct a path to the root directory of the file system. The root
91 /// directory is a top level directory above which there are no more
92 /// directories. For example, on UNIX, the root directory is /. On Windows
93 /// it is C:\. Other operating systems may have different notions of
94 /// what the root directory is or none at all. In that case, a consistent
95 /// default root directory will be used.
96 static Path GetRootDirectory();
98 /// Construct a path to a unique temporary directory that is created in
99 /// a "standard" place for the operating system. The directory is
100 /// guaranteed to be created on exit from this function. If the directory
101 /// cannot be created, the function will throw an exception.
102 /// @returns an invalid path (empty) on error
103 /// @param ErrMsg Optional place for an error message if an error occurs
104 /// @brief Constrct a path to an new, unique, existing temporary
106 static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
108 /// Construct a vector of sys::Path that contains the "standard" system
109 /// library paths suitable for linking into programs. This function *must*
110 /// return the value of LLVM_LIB_SEARCH_PATH as the first item in \p Paths
111 /// if that environment variable is set and it references a directory.
112 /// @brief Construct a path to the system library directory
113 static void GetSystemLibraryPaths(std::vector<sys::Path>& Paths);
115 /// Construct a vector of sys::Path that contains the "standard" bitcode
116 /// library paths suitable for linking into an llvm program. This function
117 /// *must* return the value of LLVM_LIB_SEARCH_PATH as well as the value
118 /// of LLVM_LIBDIR. It also must provide the System library paths as
119 /// returned by GetSystemLibraryPaths.
120 /// @see GetSystemLibraryPaths
121 /// @brief Construct a list of directories in which bitcode could be
123 static void GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths);
125 /// Find the path to a library using its short name. Use the system
126 /// dependent library paths to locate the library.
127 /// @brief Find a library.
128 static Path FindLibrary(std::string& short_name);
130 /// Construct a path to the default LLVM configuration directory. The
131 /// implementation must ensure that this is a well-known (same on many
132 /// systems) directory in which llvm configuration files exist. For
133 /// example, on Unix, the /etc/llvm directory has been selected.
134 /// @brief Construct a path to the default LLVM configuration directory
135 static Path GetLLVMDefaultConfigDir();
137 /// Construct a path to the LLVM installed configuration directory. The
138 /// implementation must ensure that this refers to the "etc" directory of
139 /// the LLVM installation. This is the location where configuration files
140 /// will be located for a particular installation of LLVM on a machine.
141 /// @brief Construct a path to the LLVM installed configuration directory
142 static Path GetLLVMConfigDir();
144 /// Construct a path to the current user's home directory. The
145 /// implementation must use an operating system specific mechanism for
146 /// determining the user's home directory. For example, the environment
147 /// variable "HOME" could be used on Unix. If a given operating system
148 /// does not have the concept of a user's home directory, this static
149 /// constructor must provide the same result as GetRootDirectory.
150 /// @brief Construct a path to the current user's "home" directory
151 static Path GetUserHomeDirectory();
153 /// Construct a path to the current directory for the current process.
154 /// @returns The current working directory.
155 /// @brief Returns the current working directory.
156 static Path GetCurrentDirectory();
158 /// Return the suffix commonly used on file names that contain a shared
159 /// object, shared archive, or dynamic link library. Such files are
160 /// linked at runtime into a process and their code images are shared
161 /// between processes.
162 /// @returns The dynamic link library suffix for the current platform.
163 /// @brief Return the dynamic link library suffix.
164 static std::string GetDLLSuffix();
166 /// GetMainExecutable - Return the path to the main executable, given the
167 /// value of argv[0] from program startup and the address of main itself.
168 static Path GetMainExecutable(const char *argv0, void *MainAddr);
170 /// This is one of the very few ways in which a path can be constructed
171 /// with a syntactically invalid name. The only *legal* invalid name is an
172 /// empty one. Other invalid names are not permitted. Empty paths are
173 /// provided so that they can be used to indicate null or error results in
174 /// other lib/System functionality.
175 /// @brief Construct an empty (and invalid) path.
177 Path(const Path &that) : path(that.path) {}
179 /// This constructor will accept a std::string as a path. No checking is
180 /// done on this path to determine if it is valid. To determine validity
181 /// of the path, use the isValid method.
182 /// @param p The path to assign.
183 /// @brief Construct a Path from a string.
184 explicit Path(const std::string& p);
186 /// This constructor will accept a character range as a path. No checking
187 /// is done on this path to determine if it is valid. To determine
188 /// validity of the path, use the isValid method.
189 /// @param StrStart A pointer to the first character of the path name
190 /// @param StrLen The length of the path name at StrStart
191 /// @brief Construct a Path from a string.
192 Path(const char *StrStart, unsigned StrLen);
198 /// Makes a copy of \p that to \p this.
200 /// @brief Assignment Operator
201 Path &operator=(const Path &that) {
206 /// Makes a copy of \p that to \p this.
207 /// @param \p that A std::string denoting the path
209 /// @brief Assignment Operator
210 Path &operator=(const std::string &that);
212 /// Compares \p this Path with \p that Path for equality.
213 /// @returns true if \p this and \p that refer to the same thing.
214 /// @brief Equality Operator
215 bool operator==(const Path &that) const;
217 /// Compares \p this Path with \p that Path for inequality.
218 /// @returns true if \p this and \p that refer to different things.
219 /// @brief Inequality Operator
220 bool operator!=(const Path &that) const;
222 /// Determines if \p this Path is less than \p that Path. This is required
223 /// so that Path objects can be placed into ordered collections (e.g.
224 /// std::map). The comparison is done lexicographically as defined by
225 /// the std::string::compare method.
226 /// @returns true if \p this path is lexicographically less than \p that.
227 /// @brief Less Than Operator
228 bool operator<(const Path& that) const;
231 /// @name Path Accessors
234 /// This function will use an operating system specific algorithm to
235 /// determine if the current value of \p this is a syntactically valid
236 /// path name for the operating system. The path name does not need to
237 /// exist, validity is simply syntactical. Empty paths are always invalid.
238 /// @returns true iff the path name is syntactically legal for the
239 /// host operating system.
240 /// @brief Determine if a path is syntactically valid or not.
241 bool isValid() const;
243 /// This function determines if the contents of the path name are empty.
244 /// That is, the path name has a zero length. This does NOT determine if
245 /// if the file is empty. To get the length of the file itself, Use the
246 /// PathWithStatus::getFileStatus() method and then the getSize() method
247 /// on the returned FileStatus object.
248 /// @returns true iff the path is empty.
249 /// @brief Determines if the path name is empty (invalid).
250 bool isEmpty() const { return path.empty(); }
252 /// This function returns the current contents of the path as a
253 /// std::string. This allows the underlying path string to be manipulated.
254 /// @returns std::string containing the path name.
255 /// @brief Returns the path as a std::string.
256 const std::string &toString() const { return path; }
258 /// This function returns the last component of the path name. The last
259 /// component is the file or directory name occuring after the last
260 /// directory separator. If no directory separator is present, the entire
261 /// path name is returned (i.e. same as toString).
262 /// @returns std::string containing the last component of the path name.
263 /// @brief Returns the last component of the path name.
264 std::string getLast() const;
266 /// This function strips off the path and suffix of the file or directory
267 /// name and returns just the basename. For example /a/foo.bar would cause
268 /// this function to return "foo".
269 /// @returns std::string containing the basename of the path
270 /// @brief Get the base name of the path
271 std::string getBasename() const;
273 /// This function strips off the suffix of the path beginning with the
274 /// path separator ('/' on Unix, '\' on Windows) and returns the result.
275 std::string getDirname() const;
277 /// This function strips off the path and basename(up to and
278 /// including the last dot) of the file or directory name and
279 /// returns just the suffix. For example /a/foo.bar would cause
280 /// this function to return "bar".
281 /// @returns std::string containing the suffix of the path
282 /// @brief Get the suffix of the path
283 std::string getSuffix() const;
285 /// Obtain a 'C' string for the path name.
286 /// @returns a 'C' string containing the path name.
287 /// @brief Returns the path as a C string.
288 const char *c_str() const { return path.c_str(); }
290 /// size - Return the length in bytes of this path name.
291 size_t size() const { return path.size(); }
293 /// empty - Returns true if the path is empty.
294 unsigned empty() const { return path.empty(); }
297 /// @name Disk Accessors
300 /// This function determines if the path name in this object references
301 /// the root (top level directory) of the file system. The details of what
302 /// is considered the "root" may vary from system to system so this method
303 /// will do the necessary checking.
304 /// @returns true iff the path name references the root directory.
305 /// @brief Determines if the path references the root directory.
306 bool isRootDirectory() const;
308 /// This function determines if the path name is absolute, as opposed to
310 /// @brief Determine if the path is absolute.
311 bool isAbsolute() const;
313 /// This function determines if the path name is absolute, as opposed to
315 /// @brief Determine if the path is absolute.
316 static bool isAbsolute(const char *NameStart, unsigned NameLen);
318 /// This function opens the file associated with the path name provided by
319 /// the Path object and reads its magic number. If the magic number at the
320 /// start of the file matches \p magic, true is returned. In all other
321 /// cases (file not found, file not accessible, etc.) it returns false.
322 /// @returns true if the magic number of the file matches \p magic.
323 /// @brief Determine if file has a specific magic number
324 bool hasMagicNumber(const std::string& magic) const;
326 /// This function retrieves the first \p len bytes of the file associated
327 /// with \p this. These bytes are returned as the "magic number" in the
328 /// \p Magic parameter.
329 /// @returns true if the Path is a file and the magic number is retrieved,
331 /// @brief Get the file's magic number.
332 bool getMagicNumber(std::string& Magic, unsigned len) const;
334 /// This function determines if the path name in the object references an
335 /// archive file by looking at its magic number.
336 /// @returns true if the file starts with the magic number for an archive
338 /// @brief Determine if the path references an archive file.
339 bool isArchive() const;
341 /// This function determines if the path name in the object references an
342 /// LLVM Bitcode file by looking at its magic number.
343 /// @returns true if the file starts with the magic number for LLVM
345 /// @brief Determine if the path references a bitcode file.
346 bool isBitcodeFile() const;
348 /// This function determines if the path name in the object references a
349 /// native Dynamic Library (shared library, shared object) by looking at
350 /// the file's magic number. The Path object must reference a file, not a
352 /// @return strue if the file starts with the magid number for a native
354 /// @brief Determine if the path reference a dynamic library.
355 bool isDynamicLibrary() const;
357 /// This function determines if the path name references an existing file
358 /// or directory in the file system.
359 /// @returns true if the pathname references an existing file or
361 /// @brief Determines if the path is a file or directory in
365 /// This function determines if the path name refences an
366 /// existing directory.
367 /// @returns true if the pathname references an existing directory.
368 /// @brief Determins if the path is a directory in the file system.
369 bool isDirectory() const;
371 /// This function determines if the path name references a readable file
372 /// or directory in the file system. This function checks for
373 /// the existence and readability (by the current program) of the file
375 /// @returns true if the pathname references a readable file.
376 /// @brief Determines if the path is a readable file or directory
377 /// in the file system.
378 bool canRead() const;
380 /// This function determines if the path name references a writable file
381 /// or directory in the file system. This function checks for the
382 /// existence and writability (by the current program) of the file or
384 /// @returns true if the pathname references a writable file.
385 /// @brief Determines if the path is a writable file or directory
386 /// in the file system.
387 bool canWrite() const;
389 /// This function determines if the path name references an executable
390 /// file in the file system. This function checks for the existence and
391 /// executability (by the current program) of the file.
392 /// @returns true if the pathname references an executable file.
393 /// @brief Determines if the path is an executable file in the file
395 bool canExecute() const;
397 /// This function builds a list of paths that are the names of the
398 /// files and directories in a directory.
399 /// @returns true if an error occurs, true otherwise
400 /// @brief Build a list of directory's contents.
401 bool getDirectoryContents(
402 std::set<Path> &paths, ///< The resulting list of file & directory names
403 std::string* ErrMsg ///< Optional place to return an error message.
407 /// @name Path Mutators
410 /// The path name is cleared and becomes empty. This is an invalid
411 /// path name but is the *only* invalid path name. This is provided
412 /// so that path objects can be used to indicate the lack of a
413 /// valid path being found.
414 /// @brief Make the path empty.
415 void clear() { path.clear(); }
417 /// This method sets the Path object to \p unverified_path. This can fail
418 /// if the \p unverified_path does not pass the syntactic checks of the
419 /// isValid() method. If verification fails, the Path object remains
420 /// unchanged and false is returned. Otherwise true is returned and the
421 /// Path object takes on the path value of \p unverified_path
422 /// @returns true if the path was set, false otherwise.
423 /// @param unverified_path The path to be set in Path object.
424 /// @brief Set a full path from a std::string
425 bool set(const std::string& unverified_path);
427 /// One path component is removed from the Path. If only one component is
428 /// present in the path, the Path object becomes empty. If the Path object
429 /// is empty, no change is made.
430 /// @returns false if the path component could not be removed.
431 /// @brief Removes the last directory component of the Path.
432 bool eraseComponent();
434 /// The \p component is added to the end of the Path if it is a legal
435 /// name for the operating system. A directory separator will be added if
437 /// @returns false if the path component could not be added.
438 /// @brief Appends one path component to the Path.
439 bool appendComponent( const std::string& component );
441 /// A period and the \p suffix are appended to the end of the pathname.
442 /// The precondition for this function is that the Path reference a file
443 /// name (i.e. isFile() returns true). If the Path is not a file, no
444 /// action is taken and the function returns false. If the path would
445 /// become invalid for the host operating system, false is returned.
446 /// @returns false if the suffix could not be added, true if it was.
447 /// @brief Adds a period and the \p suffix to the end of the pathname.
448 bool appendSuffix(const std::string& suffix);
450 /// The suffix of the filename is erased. The suffix begins with and
451 /// includes the last . character in the filename after the last directory
452 /// separator and extends until the end of the name. If no . character is
453 /// after the last directory separator, then the file name is left
454 /// unchanged (i.e. it was already without a suffix) but the function
456 /// @returns false if there was no suffix to remove, true otherwise.
457 /// @brief Remove the suffix from a path name.
460 /// The current Path name is made unique in the file system. Upon return,
461 /// the Path will have been changed to make a unique file in the file
462 /// system or it will not have been changed if the current path name is
464 /// @throws std::string if an unrecoverable error occurs.
465 /// @brief Make the current path name unique in the file system.
466 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
468 /// The current Path name is made absolute by prepending the
469 /// current working directory if necessary.
473 /// @name Disk Mutators
476 /// This method attempts to make the file referenced by the Path object
477 /// available for reading so that the canRead() method will return true.
478 /// @brief Make the file readable;
479 bool makeReadableOnDisk(std::string* ErrMsg = 0);
481 /// This method attempts to make the file referenced by the Path object
482 /// available for writing so that the canWrite() method will return true.
483 /// @brief Make the file writable;
484 bool makeWriteableOnDisk(std::string* ErrMsg = 0);
486 /// This method attempts to make the file referenced by the Path object
487 /// available for execution so that the canExecute() method will return
489 /// @brief Make the file readable;
490 bool makeExecutableOnDisk(std::string* ErrMsg = 0);
492 /// This method allows the last modified time stamp and permission bits
493 /// to be set on the disk object referenced by the Path.
494 /// @throws std::string if an error occurs.
495 /// @returns true on error.
496 /// @brief Set the status information.
497 bool setStatusInfoOnDisk(const FileStatus &SI,
498 std::string *ErrStr = 0) const;
500 /// This method attempts to create a directory in the file system with the
501 /// same name as the Path object. The \p create_parents parameter controls
502 /// whether intermediate directories are created or not. if \p
503 /// create_parents is true, then an attempt will be made to create all
504 /// intermediate directories, as needed. If \p create_parents is false,
505 /// then only the final directory component of the Path name will be
506 /// created. The created directory will have no entries.
507 /// @returns true if the directory could not be created, false otherwise
508 /// @brief Create the directory this Path refers to.
509 bool createDirectoryOnDisk(
510 bool create_parents = false, ///< Determines whether non-existent
511 ///< directory components other than the last one (the "parents")
512 ///< are created or not.
513 std::string* ErrMsg = 0 ///< Optional place to put error messages.
516 /// This method attempts to create a file in the file system with the same
517 /// name as the Path object. The intermediate directories must all exist
518 /// at the time this method is called. Use createDirectoriesOnDisk to
519 /// accomplish that. The created file will be empty upon return from this
521 /// @returns true if the file could not be created, false otherwise.
522 /// @brief Create the file this Path refers to.
523 bool createFileOnDisk(
524 std::string* ErrMsg = 0 ///< Optional place to put error messages.
527 /// This is like createFile except that it creates a temporary file. A
528 /// unique temporary file name is generated based on the contents of
529 /// \p this before the call. The new name is assigned to \p this and the
530 /// file is created. Note that this will both change the Path object
531 /// *and* create the corresponding file. This function will ensure that
532 /// the newly generated temporary file name is unique in the file system.
533 /// @returns true if the file couldn't be created, false otherwise.
534 /// @brief Create a unique temporary file
535 bool createTemporaryFileOnDisk(
536 bool reuse_current = false, ///< When set to true, this parameter
537 ///< indicates that if the current file name does not exist then
538 ///< it will be used without modification.
539 std::string* ErrMsg = 0 ///< Optional place to put error messages
542 /// This method renames the file referenced by \p this as \p newName. The
543 /// file referenced by \p this must exist. The file referenced by
544 /// \p newName does not need to exist.
545 /// @returns true on error, false otherwise
546 /// @brief Rename one file as another.
547 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
549 /// This method attempts to destroy the file or directory named by the
550 /// last component of the Path. If the Path refers to a directory and the
551 /// \p destroy_contents is false, an attempt will be made to remove just
552 /// the directory (the final Path component). If \p destroy_contents is
553 /// true, an attempt will be made to remove the entire contents of the
554 /// directory, recursively. If the Path refers to a file, the
555 /// \p destroy_contents parameter is ignored.
556 /// @param destroy_contents Indicates whether the contents of a destroyed
557 /// @param Err An optional string to receive an error message.
558 /// directory should also be destroyed (recursively).
559 /// @returns false if the file/directory was destroyed, true on error.
560 /// @brief Removes the file or directory from the filesystem.
561 bool eraseFromDisk(bool destroy_contents = false,
562 std::string *Err = 0) const;
565 /// MapInFilePages - This is a low level system API to map in the file
566 /// that is currently opened as FD into the current processes' address
567 /// space for read only access. This function may return null on failure
568 /// or if the system cannot provide the following constraints:
569 /// 1) The pages must be valid after the FD is closed, until
570 /// UnMapFilePages is called.
571 /// 2) Any padding after the end of the file must be zero filled, if
573 /// 3) The pages must be contiguous.
575 /// This API is not intended for general use, clients should use
576 /// MemoryBuffer::getFile instead.
577 static const char *MapInFilePages(int FD, uint64_t FileSize);
579 /// UnMapFilePages - Free pages mapped into the current process by
582 /// This API is not intended for general use, clients should use
583 /// MemoryBuffer::getFile instead.
584 static void UnMapFilePages(const char *Base, uint64_t FileSize);
590 mutable std::string path; ///< Storage for the path name.
596 /// This class is identical to Path class except it allows you to obtain the
597 /// file status of the Path as well. The reason for the distinction is one of
598 /// efficiency. First, the file status requires additional space and the space
599 /// is incorporated directly into PathWithStatus without an additional malloc.
600 /// Second, obtaining status information is an expensive operation on most
601 /// operating systems so we want to be careful and explicity about where we
602 /// allow this operation in LLVM.
603 /// @brief Path with file status class.
604 class PathWithStatus : public Path {
605 /// @name Constructors
608 /// @brief Default constructor
609 PathWithStatus() : Path(), status(), fsIsValid(false) {}
611 /// @brief Copy constructor
612 PathWithStatus(const PathWithStatus &that)
613 : Path(static_cast<const Path&>(that)), status(that.status),
614 fsIsValid(that.fsIsValid) {}
616 /// This constructor allows construction from a Path object
617 /// @brief Path constructor
618 PathWithStatus(const Path &other)
619 : Path(other), status(), fsIsValid(false) {}
621 /// This constructor will accept a std::string as a path. No checking is
622 /// done on this path to determine if it is valid. To determine validity
623 /// of the path, use the isValid method.
624 /// @brief Construct a Path from a string.
625 explicit PathWithStatus(
626 const std::string& p ///< The path to assign.
627 ) : Path(p), status(), fsIsValid(false) {}
629 /// This constructor will accept a character range as a path. No checking
630 /// is done on this path to determine if it is valid. To determine
631 /// validity of the path, use the isValid method.
632 /// @brief Construct a Path from a string.
633 explicit PathWithStatus(
634 const char *StrStart, ///< Pointer to the first character of the path
635 unsigned StrLen ///< Length of the path.
636 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
638 /// Makes a copy of \p that to \p this.
640 /// @brief Assignment Operator
641 PathWithStatus &operator=(const PathWithStatus &that) {
642 static_cast<Path&>(*this) = static_cast<const Path&>(that);
643 status = that.status;
644 fsIsValid = that.fsIsValid;
648 /// Makes a copy of \p that to \p this.
650 /// @brief Assignment Operator
651 PathWithStatus &operator=(const Path &that) {
652 static_cast<Path&>(*this) = static_cast<const Path&>(that);
661 /// This function returns status information about the file. The type of
662 /// path (file or directory) is updated to reflect the actual contents
663 /// of the file system.
664 /// @returns 0 on failure, with Error explaining why (if non-zero)
665 /// @returns a pointer to a FileStatus structure on success.
666 /// @brief Get file status.
667 const FileStatus *getFileStatus(
668 bool forceUpdate = false, ///< Force an update from the file system
669 std::string *Error = 0 ///< Optional place to return an error msg.
676 mutable FileStatus status; ///< Status information.
677 mutable bool fsIsValid; ///< Whether we've obtained it or not
682 /// This enumeration delineates the kinds of files that LLVM knows about.
684 Unknown_FileType = 0, ///< Unrecognized file
685 Bitcode_FileType, ///< Bitcode file
686 Archive_FileType, ///< ar style archive file
687 ELF_Relocatable_FileType, ///< ELF Relocatable object file
688 ELF_Executable_FileType, ///< ELF Executable image
689 ELF_SharedObject_FileType, ///< ELF dynamically linked shared lib
690 ELF_Core_FileType, ///< ELF core image
691 Mach_O_Object_FileType, ///< Mach-O Object file
692 Mach_O_Executable_FileType, ///< Mach-O Executable
693 Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM
694 Mach_O_Core_FileType, ///< Mach-O Core File
695 Mach_O_PreloadExectuable_FileType, ///< Mach-O Preloaded Executable
696 Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib
697 Mach_O_DynamicLinker_FileType, ///< The Mach-O dynamic linker
698 Mach_O_Bundle_FileType, ///< Mach-O Bundle file
699 Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub
700 COFF_FileType ///< COFF object file or lib
703 /// This utility function allows any memory block to be examined in order
704 /// to determine its file type.
705 LLVMFileType IdentifyFileType(const char*magic, unsigned length);
707 /// This function can be used to copy the file specified by Src to the
708 /// file specified by Dest. If an error occurs, Dest is removed.
709 /// @returns true if an error occurs, false otherwise
710 /// @brief Copy one file to another.
711 bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg);
713 /// This is the OS-specific path separator: a colon on Unix or a semicolon
715 extern const char PathSeparator;
718 inline raw_ostream& operator<<(raw_ostream& strm, const sys::Path& aPath) {
719 strm << aPath.toString();
723 inline raw_ostream& operator<<(raw_ostream& strm,
724 const sys::PathWithStatus& aPath) {
725 strm << static_cast<const sys::Path&>(aPath);
729 std::ostream& operator<<(std::ostream& strm, const sys::Path& aPath);
730 inline std::ostream& operator<<(std::ostream& strm,
731 const sys::PathWithStatus& aPath) {
732 strm << static_cast<const sys::Path&>(aPath);