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_SYSTEM_PATH_H
15 #define LLVM_SYSTEM_PATH_H
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Support/Compiler.h"
19 #include "llvm/Support/TimeValue.h"
24 #define LLVMV_PATH_DEPRECATED_MSG \
25 "PathV1 is being deprecated, please use the PathV2 API."
30 /// This structure provides basic file system information about a file. It
31 /// is patterned after the stat(2) Unix operating system call but made
32 /// platform independent and eliminates many of the unix-specific fields.
33 /// However, to support llvm-ar, the mode, user, and group fields are
34 /// retained. These pertain to unix security and may not have a meaningful
35 /// value on non-Unix platforms. However, the other fields should
36 /// always be applicable on all platforms. The structure is filled in by
37 /// the PathWithStatus class.
38 /// @brief File status structure
41 uint64_t fileSize; ///< Size of the file in bytes
42 TimeValue modTime; ///< Time of file's modification
43 uint32_t mode; ///< Mode of the file, if applicable
44 uint32_t user; ///< User ID of owner, if applicable
45 uint32_t group; ///< Group ID of owner, if applicable
46 uint64_t uniqueID; ///< A number to uniquely ID this file
47 bool isDir : 1; ///< True if this is a directory.
48 bool isFile : 1; ///< True if this is a file.
50 FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
51 group(999), uniqueID(0), isDir(false), isFile(false) { }
53 TimeValue getTimestamp() const { return modTime; }
54 uint64_t getSize() const { return fileSize; }
55 uint32_t getMode() const { return mode; }
56 uint32_t getUser() const { return user; }
57 uint32_t getGroup() const { return group; }
58 uint64_t getUniqueID() const { return uniqueID; }
61 /// This class provides an abstraction for the path to a file or directory
62 /// in the operating system's filesystem and provides various basic operations
63 /// on it. Note that this class only represents the name of a path to a file
64 /// or directory which may or may not be valid for a given machine's file
65 /// system. The class is patterned after the java.io.File class with various
66 /// extensions and several omissions (not relevant to LLVM). A Path object
67 /// ensures that the path it encapsulates is syntactically valid for the
68 /// operating system it is running on but does not ensure correctness for
69 /// any particular file system. That is, a syntactically valid path might
70 /// specify path components that do not exist in the file system and using
71 /// such a Path to act on the file system could produce errors. There is one
72 /// invalid Path value which is permitted: the empty path. The class should
73 /// never allow a syntactically invalid non-empty path name to be assigned.
74 /// Empty paths are required in order to indicate an error result in some
75 /// situations. If the path is empty, the isValid operation will return
76 /// false. All operations will fail if isValid is false. Operations that
77 /// change the path will either return false if it would cause a syntactically
78 /// invalid path name (in which case the Path object is left unchanged) or
79 /// throw an std::string exception indicating the error. The methods are
80 /// grouped into four basic categories: Path Accessors (provide information
81 /// about the path without accessing disk), Disk Accessors (provide
82 /// information about the underlying file or directory), Path Mutators
83 /// (change the path information, not the disk), and Disk Mutators (change
84 /// the disk file/directory referenced by the path). The Disk Mutator methods
85 /// all have the word "disk" embedded in their method name to reinforce the
86 /// notion that the operation modifies the file system.
88 /// @brief An abstraction for operating system paths.
90 /// @name Constructors
93 /// Construct a path to the root directory of the file system. The root
94 /// directory is a top level directory above which there are no more
95 /// directories. For example, on UNIX, the root directory is /. On Windows
96 /// it is file:///. Other operating systems may have different notions of
97 /// what the root directory is or none at all. In that case, a consistent
98 /// default root directory will be used.
99 static Path GetRootDirectory();
101 /// Construct a path to a unique temporary directory that is created in
102 /// a "standard" place for the operating system. The directory is
103 /// guaranteed to be created on exit from this function. If the directory
104 /// cannot be created, the function will throw an exception.
105 /// @returns an invalid path (empty) on error
106 /// @param ErrMsg Optional place for an error message if an error occurs
107 /// @brief Constrct a path to an new, unique, existing temporary
109 static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
111 /// Construct a vector of sys::Path that contains the "standard" system
112 /// library paths suitable for linking into programs.
113 /// @brief Construct a path to the system library directory
114 static void GetSystemLibraryPaths(std::vector<sys::Path>& Paths);
116 /// Construct a vector of sys::Path that contains the "standard" bitcode
117 /// library paths suitable for linking into an llvm program. This function
118 /// *must* return the value of LLVM_LIB_SEARCH_PATH as well as the value
119 /// of LLVM_LIBDIR. It also must provide the System library paths as
120 /// returned by GetSystemLibraryPaths.
121 /// @see GetSystemLibraryPaths
122 /// @brief Construct a list of directories in which bitcode could be
124 static void GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths);
126 /// Find the path to a library using its short name. Use the system
127 /// dependent library paths to locate the library.
128 /// @brief Find a library.
129 static Path FindLibrary(std::string& short_name);
131 /// Construct a path to the default LLVM configuration directory. The
132 /// implementation must ensure that this is a well-known (same on many
133 /// systems) directory in which llvm configuration files exist. For
134 /// example, on Unix, the /etc/llvm directory has been selected.
135 /// @brief Construct a path to the default LLVM configuration directory
136 static Path GetLLVMDefaultConfigDir();
138 /// Construct a path to the LLVM installed configuration directory. The
139 /// implementation must ensure that this refers to the "etc" directory of
140 /// the LLVM installation. This is the location where configuration files
141 /// will be located for a particular installation of LLVM on a machine.
142 /// @brief Construct a path to the LLVM installed configuration directory
143 static Path GetLLVMConfigDir();
145 /// Construct a path to the current user's home directory. The
146 /// implementation must use an operating system specific mechanism for
147 /// determining the user's home directory. For example, the environment
148 /// variable "HOME" could be used on Unix. If a given operating system
149 /// does not have the concept of a user's home directory, this static
150 /// constructor must provide the same result as GetRootDirectory.
151 /// @brief Construct a path to the current user's "home" directory
152 static Path GetUserHomeDirectory();
154 /// Construct a path to the current directory for the current process.
155 /// @returns The current working directory.
156 /// @brief Returns the current working directory.
157 static Path GetCurrentDirectory();
159 /// Return the suffix commonly used on file names that contain an
161 /// @returns The executable file suffix for the current platform.
162 /// @brief Return the executable file suffix.
163 static StringRef GetEXESuffix();
165 /// Return the suffix commonly used on file names that contain a shared
166 /// object, shared archive, or dynamic link library. Such files are
167 /// linked at runtime into a process and their code images are shared
168 /// between processes.
169 /// @returns The dynamic link library suffix for the current platform.
170 /// @brief Return the dynamic link library suffix.
171 static StringRef GetDLLSuffix();
173 /// GetMainExecutable - Return the path to the main executable, given the
174 /// value of argv[0] from program startup and the address of main itself.
175 /// In extremis, this function may fail and return an empty path.
176 static Path GetMainExecutable(const char *argv0, void *MainAddr);
178 /// This is one of the very few ways in which a path can be constructed
179 /// with a syntactically invalid name. The only *legal* invalid name is an
180 /// empty one. Other invalid names are not permitted. Empty paths are
181 /// provided so that they can be used to indicate null or error results in
182 /// other lib/System functionality.
183 /// @brief Construct an empty (and invalid) path.
185 Path(const Path &that) : path(that.path) {}
187 /// This constructor will accept a char* or std::string as a path. No
188 /// checking is done on this path to determine if it is valid. To
189 /// determine validity of the path, use the isValid method.
190 /// @param p The path to assign.
191 /// @brief Construct a Path from a string.
192 explicit Path(StringRef p);
194 /// This constructor will accept a character range as a path. No checking
195 /// is done on this path to determine if it is valid. To determine
196 /// validity of the path, use the isValid method.
197 /// @param StrStart A pointer to the first character of the path name
198 /// @param StrLen The length of the path name at StrStart
199 /// @brief Construct a Path from a string.
200 Path(const char *StrStart, unsigned StrLen);
206 /// Makes a copy of \p that to \p this.
208 /// @brief Assignment Operator
209 Path &operator=(const Path &that) {
214 /// Makes a copy of \p that to \p this.
215 /// @param that A StringRef denoting the path
217 /// @brief Assignment Operator
218 Path &operator=(StringRef that);
220 /// Compares \p this Path with \p that Path for equality.
221 /// @returns true if \p this and \p that refer to the same thing.
222 /// @brief Equality Operator
223 bool operator==(const Path &that) const;
225 /// Compares \p this Path with \p that Path for inequality.
226 /// @returns true if \p this and \p that refer to different things.
227 /// @brief Inequality Operator
228 bool operator!=(const Path &that) const { return !(*this == that); }
230 /// Determines if \p this Path is less than \p that Path. This is required
231 /// so that Path objects can be placed into ordered collections (e.g.
232 /// std::map). The comparison is done lexicographically as defined by
233 /// the std::string::compare method.
234 /// @returns true if \p this path is lexicographically less than \p that.
235 /// @brief Less Than Operator
236 bool operator<(const Path& that) const;
239 /// @name Path Accessors
242 /// This function will use an operating system specific algorithm to
243 /// determine if the current value of \p this is a syntactically valid
244 /// path name for the operating system. The path name does not need to
245 /// exist, validity is simply syntactical. Empty paths are always invalid.
246 /// @returns true iff the path name is syntactically legal for the
247 /// host operating system.
248 /// @brief Determine if a path is syntactically valid or not.
249 bool isValid() const;
251 /// This function determines if the contents of the path name are empty.
252 /// That is, the path name has a zero length. This does NOT determine if
253 /// if the file is empty. To get the length of the file itself, Use the
254 /// PathWithStatus::getFileStatus() method and then the getSize() method
255 /// on the returned FileStatus object.
256 /// @returns true iff the path is empty.
257 /// @brief Determines if the path name is empty (invalid).
258 bool isEmpty() const { return path.empty(); }
260 /// This function returns the last component of the path name. The last
261 /// component is the file or directory name occuring after the last
262 /// directory separator. If no directory separator is present, the entire
263 /// path name is returned (i.e. same as toString).
264 /// @returns StringRef containing the last component of the path name.
265 /// @brief Returns the last component of the path name.
266 LLVM_ATTRIBUTE_DEPRECATED(
267 StringRef getLast() const,
268 LLVMV_PATH_DEPRECATED_MSG);
270 /// This function strips off the path and suffix of the file or directory
271 /// name and returns just the basename. For example /a/foo.bar would cause
272 /// this function to return "foo".
273 /// @returns StringRef containing the basename of the path
274 /// @brief Get the base name of the path
275 StringRef getBasename() const;
277 /// This function strips off the suffix of the path beginning with the
278 /// path separator ('/' on Unix, '\' on Windows) and returns the result.
279 StringRef getDirname() const;
281 /// This function strips off the path and basename(up to and
282 /// including the last dot) of the file or directory name and
283 /// returns just the suffix. For example /a/foo.bar would cause
284 /// this function to return "bar".
285 /// @returns StringRef containing the suffix of the path
286 /// @brief Get the suffix of the path
287 StringRef getSuffix() const;
289 /// Obtain a 'C' string for the path name.
290 /// @returns a 'C' string containing the path name.
291 /// @brief Returns the path as a C string.
292 const char *c_str() const { return path.c_str(); }
293 const std::string &str() const { return path; }
296 /// size - Return the length in bytes of this path name.
297 size_t size() const { return path.size(); }
299 /// empty - Returns true if the path is empty.
300 unsigned empty() const { return path.empty(); }
303 /// @name Disk Accessors
306 /// This function determines if the path name is absolute, as opposed to
308 /// @brief Determine if the path is absolute.
309 LLVM_ATTRIBUTE_DEPRECATED(
310 bool isAbsolute() const,
311 LLVMV_PATH_DEPRECATED_MSG);
313 /// This function determines if the path name is absolute, as opposed to
315 /// @brief Determine if the path is absolute.
316 LLVM_ATTRIBUTE_DEPRECATED(
317 static bool isAbsolute(const char *NameStart, unsigned NameLen),
318 LLVMV_PATH_DEPRECATED_MSG);
320 /// This function opens the file associated with the path name provided by
321 /// the Path object and reads its magic number. If the magic number at the
322 /// start of the file matches \p magic, true is returned. In all other
323 /// cases (file not found, file not accessible, etc.) it returns false.
324 /// @returns true if the magic number of the file matches \p magic.
325 /// @brief Determine if file has a specific magic number
326 bool hasMagicNumber(StringRef magic) const;
328 /// This function retrieves the first \p len bytes of the file associated
329 /// with \p this. These bytes are returned as the "magic number" in the
330 /// \p Magic parameter.
331 /// @returns true if the Path is a file and the magic number is retrieved,
333 /// @brief Get the file's magic number.
334 bool getMagicNumber(std::string& Magic, unsigned len) const;
336 /// This function determines if the path name in the object references an
337 /// archive file by looking at its magic number.
338 /// @returns true if the file starts with the magic number for an archive
340 /// @brief Determine if the path references an archive file.
341 bool isArchive() const;
343 /// This function determines if the path name in the object references an
344 /// LLVM Bitcode file by looking at its magic number.
345 /// @returns true if the file starts with the magic number for LLVM
347 /// @brief Determine if the path references a bitcode file.
348 bool isBitcodeFile() const;
350 /// This function determines if the path name in the object references a
351 /// native Dynamic Library (shared library, shared object) by looking at
352 /// the file's magic number. The Path object must reference a file, not a
354 /// @returns true if the file starts with the magic number for a native
356 /// @brief Determine if the path references a dynamic library.
357 bool isDynamicLibrary() const;
359 /// This function determines if the path name in the object references a
360 /// native object file by looking at it's magic number. The term object
361 /// file is defined as "an organized collection of separate, named
362 /// sequences of binary data." This covers the obvious file formats such
363 /// as COFF and ELF, but it also includes llvm ir bitcode, archives,
364 /// libraries, etc...
365 /// @returns true if the file starts with the magic number for an object
367 /// @brief Determine if the path references an object file.
368 bool isObjectFile() const;
370 /// This function determines if the path name references an existing file
371 /// or directory in the file system.
372 /// @returns true if the pathname references an existing file or
374 /// @brief Determines if the path is a file or directory in
378 /// This function determines if the path name references an
379 /// existing directory.
380 /// @returns true if the pathname references an existing directory.
381 /// @brief Determines if the path is a directory in the file system.
382 bool isDirectory() const;
384 /// This function determines if the path name references an
385 /// existing symbolic link.
386 /// @returns true if the pathname references an existing symlink.
387 /// @brief Determines if the path is a symlink in the file system.
388 bool isSymLink() const;
390 /// This function determines if the path name references a readable file
391 /// or directory in the file system. This function checks for
392 /// the existence and readability (by the current program) of the file
394 /// @returns true if the pathname references a readable file.
395 /// @brief Determines if the path is a readable file or directory
396 /// in the file system.
397 bool canRead() const;
399 /// This function determines if the path name references a writable file
400 /// or directory in the file system. This function checks for the
401 /// existence and writability (by the current program) of the file or
403 /// @returns true if the pathname references a writable file.
404 /// @brief Determines if the path is a writable file or directory
405 /// in the file system.
406 bool canWrite() const;
408 /// This function checks that what we're trying to work only on a regular
409 /// file. Check for things like /dev/null, any block special file, or
410 /// other things that aren't "regular" regular files.
411 /// @returns true if the file is S_ISREG.
412 /// @brief Determines if the file is a regular file
413 bool isRegularFile() const;
415 /// This function determines if the path name references an executable
416 /// file in the file system. This function checks for the existence and
417 /// executability (by the current program) of the file.
418 /// @returns true if the pathname references an executable file.
419 /// @brief Determines if the path is an executable file in the file
421 bool canExecute() const;
423 /// This function builds a list of paths that are the names of the
424 /// files and directories in a directory.
425 /// @returns true if an error occurs, true otherwise
426 /// @brief Build a list of directory's contents.
427 bool getDirectoryContents(
428 std::set<Path> &paths, ///< The resulting list of file & directory names
429 std::string* ErrMsg ///< Optional place to return an error message.
433 /// @name Path Mutators
436 /// The path name is cleared and becomes empty. This is an invalid
437 /// path name but is the *only* invalid path name. This is provided
438 /// so that path objects can be used to indicate the lack of a
439 /// valid path being found.
440 /// @brief Make the path empty.
441 void clear() { path.clear(); }
443 /// This method sets the Path object to \p unverified_path. This can fail
444 /// if the \p unverified_path does not pass the syntactic checks of the
445 /// isValid() method. If verification fails, the Path object remains
446 /// unchanged and false is returned. Otherwise true is returned and the
447 /// Path object takes on the path value of \p unverified_path
448 /// @returns true if the path was set, false otherwise.
449 /// @param unverified_path The path to be set in Path object.
450 /// @brief Set a full path from a StringRef
451 bool set(StringRef unverified_path);
453 /// One path component is removed from the Path. If only one component is
454 /// present in the path, the Path object becomes empty. If the Path object
455 /// is empty, no change is made.
456 /// @returns false if the path component could not be removed.
457 /// @brief Removes the last directory component of the Path.
458 bool eraseComponent();
460 /// The \p component is added to the end of the Path if it is a legal
461 /// name for the operating system. A directory separator will be added if
463 /// @returns false if the path component could not be added.
464 /// @brief Appends one path component to the Path.
465 bool appendComponent(StringRef component);
467 /// A period and the \p suffix are appended to the end of the pathname.
468 /// When the \p suffix is empty, no action is performed.
469 /// @brief Adds a period and the \p suffix to the end of the pathname.
470 void appendSuffix(StringRef suffix);
472 /// The suffix of the filename is erased. The suffix begins with and
473 /// includes the last . character in the filename after the last directory
474 /// separator and extends until the end of the name. If no . character is
475 /// after the last directory separator, then the file name is left
476 /// unchanged (i.e. it was already without a suffix) but the function
478 /// @returns false if there was no suffix to remove, true otherwise.
479 /// @brief Remove the suffix from a path name.
482 /// The current Path name is made unique in the file system. Upon return,
483 /// the Path will have been changed to make a unique file in the file
484 /// system or it will not have been changed if the current path name is
486 /// @throws std::string if an unrecoverable error occurs.
487 /// @brief Make the current path name unique in the file system.
488 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
490 /// The current Path name is made absolute by prepending the
491 /// current working directory if necessary.
495 /// @name Disk Mutators
498 /// This method attempts to make the file referenced by the Path object
499 /// available for reading so that the canRead() method will return true.
500 /// @brief Make the file readable;
501 bool makeReadableOnDisk(std::string* ErrMsg = 0);
503 /// This method attempts to make the file referenced by the Path object
504 /// available for writing so that the canWrite() method will return true.
505 /// @brief Make the file writable;
506 bool makeWriteableOnDisk(std::string* ErrMsg = 0);
508 /// This method attempts to make the file referenced by the Path object
509 /// available for execution so that the canExecute() method will return
511 /// @brief Make the file readable;
512 bool makeExecutableOnDisk(std::string* ErrMsg = 0);
514 /// This method allows the last modified time stamp and permission bits
515 /// to be set on the disk object referenced by the Path.
516 /// @throws std::string if an error occurs.
517 /// @returns true on error.
518 /// @brief Set the status information.
519 bool setStatusInfoOnDisk(const FileStatus &SI,
520 std::string *ErrStr = 0) const;
522 /// This method attempts to create a directory in the file system with the
523 /// same name as the Path object. The \p create_parents parameter controls
524 /// whether intermediate directories are created or not. if \p
525 /// create_parents is true, then an attempt will be made to create all
526 /// intermediate directories, as needed. If \p create_parents is false,
527 /// then only the final directory component of the Path name will be
528 /// created. The created directory will have no entries.
529 /// @returns true if the directory could not be created, false otherwise
530 /// @brief Create the directory this Path refers to.
531 bool createDirectoryOnDisk(
532 bool create_parents = false, ///< Determines whether non-existent
533 ///< directory components other than the last one (the "parents")
534 ///< are created or not.
535 std::string* ErrMsg = 0 ///< Optional place to put error messages.
538 /// This method attempts to create a file in the file system with the same
539 /// name as the Path object. The intermediate directories must all exist
540 /// at the time this method is called. Use createDirectoriesOnDisk to
541 /// accomplish that. The created file will be empty upon return from this
543 /// @returns true if the file could not be created, false otherwise.
544 /// @brief Create the file this Path refers to.
545 bool createFileOnDisk(
546 std::string* ErrMsg = 0 ///< Optional place to put error messages.
549 /// This is like createFile except that it creates a temporary file. A
550 /// unique temporary file name is generated based on the contents of
551 /// \p this before the call. The new name is assigned to \p this and the
552 /// file is created. Note that this will both change the Path object
553 /// *and* create the corresponding file. This function will ensure that
554 /// the newly generated temporary file name is unique in the file system.
555 /// @returns true if the file couldn't be created, false otherwise.
556 /// @brief Create a unique temporary file
557 bool createTemporaryFileOnDisk(
558 bool reuse_current = false, ///< When set to true, this parameter
559 ///< indicates that if the current file name does not exist then
560 ///< it will be used without modification.
561 std::string* ErrMsg = 0 ///< Optional place to put error messages
564 /// This method renames the file referenced by \p this as \p newName. The
565 /// file referenced by \p this must exist. The file referenced by
566 /// \p newName does not need to exist.
567 /// @returns true on error, false otherwise
568 /// @brief Rename one file as another.
569 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
571 /// This method attempts to destroy the file or directory named by the
572 /// last component of the Path. If the Path refers to a directory and the
573 /// \p destroy_contents is false, an attempt will be made to remove just
574 /// the directory (the final Path component). If \p destroy_contents is
575 /// true, an attempt will be made to remove the entire contents of the
576 /// directory, recursively. If the Path refers to a file, the
577 /// \p destroy_contents parameter is ignored.
578 /// @param destroy_contents Indicates whether the contents of a destroyed
579 /// @param Err An optional string to receive an error message.
580 /// directory should also be destroyed (recursively).
581 /// @returns false if the file/directory was destroyed, true on error.
582 /// @brief Removes the file or directory from the filesystem.
583 bool eraseFromDisk(bool destroy_contents = false,
584 std::string *Err = 0) const;
587 /// MapInFilePages - This is a low level system API to map in the file
588 /// that is currently opened as FD into the current processes' address
589 /// space for read only access. This function may return null on failure
590 /// or if the system cannot provide the following constraints:
591 /// 1) The pages must be valid after the FD is closed, until
592 /// UnMapFilePages is called.
593 /// 2) Any padding after the end of the file must be zero filled, if
595 /// 3) The pages must be contiguous.
597 /// This API is not intended for general use, clients should use
598 /// MemoryBuffer::getFile instead.
599 static const char *MapInFilePages(int FD, uint64_t FileSize);
601 /// UnMapFilePages - Free pages mapped into the current process by
604 /// This API is not intended for general use, clients should use
605 /// MemoryBuffer::getFile instead.
606 static void UnMapFilePages(const char *Base, uint64_t FileSize);
612 // Our win32 implementation relies on this string being mutable.
613 mutable std::string path; ///< Storage for the path name.
619 /// This class is identical to Path class except it allows you to obtain the
620 /// file status of the Path as well. The reason for the distinction is one of
621 /// efficiency. First, the file status requires additional space and the space
622 /// is incorporated directly into PathWithStatus without an additional malloc.
623 /// Second, obtaining status information is an expensive operation on most
624 /// operating systems so we want to be careful and explicity about where we
625 /// allow this operation in LLVM.
626 /// @brief Path with file status class.
627 class PathWithStatus : public Path {
628 /// @name Constructors
631 /// @brief Default constructor
632 PathWithStatus() : Path(), status(), fsIsValid(false) {}
634 /// @brief Copy constructor
635 PathWithStatus(const PathWithStatus &that)
636 : Path(static_cast<const Path&>(that)), status(that.status),
637 fsIsValid(that.fsIsValid) {}
639 /// This constructor allows construction from a Path object
640 /// @brief Path constructor
641 PathWithStatus(const Path &other)
642 : Path(other), status(), fsIsValid(false) {}
644 /// This constructor will accept a char* or std::string as a path. No
645 /// checking is done on this path to determine if it is valid. To
646 /// determine validity of the path, use the isValid method.
647 /// @brief Construct a Path from a string.
648 explicit PathWithStatus(
649 StringRef p ///< The path to assign.
650 ) : Path(p), status(), fsIsValid(false) {}
652 /// This constructor will accept a character range as a path. No checking
653 /// is done on this path to determine if it is valid. To determine
654 /// validity of the path, use the isValid method.
655 /// @brief Construct a Path from a string.
656 explicit PathWithStatus(
657 const char *StrStart, ///< Pointer to the first character of the path
658 unsigned StrLen ///< Length of the path.
659 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
661 /// Makes a copy of \p that to \p this.
663 /// @brief Assignment Operator
664 PathWithStatus &operator=(const PathWithStatus &that) {
665 static_cast<Path&>(*this) = static_cast<const Path&>(that);
666 status = that.status;
667 fsIsValid = that.fsIsValid;
671 /// Makes a copy of \p that to \p this.
673 /// @brief Assignment Operator
674 PathWithStatus &operator=(const Path &that) {
675 static_cast<Path&>(*this) = static_cast<const Path&>(that);
684 /// This function returns status information about the file. The type of
685 /// path (file or directory) is updated to reflect the actual contents
686 /// of the file system.
687 /// @returns 0 on failure, with Error explaining why (if non-zero)
688 /// @returns a pointer to a FileStatus structure on success.
689 /// @brief Get file status.
690 const FileStatus *getFileStatus(
691 bool forceUpdate = false, ///< Force an update from the file system
692 std::string *Error = 0 ///< Optional place to return an error msg.
699 mutable FileStatus status; ///< Status information.
700 mutable bool fsIsValid; ///< Whether we've obtained it or not
705 /// This enumeration delineates the kinds of files that LLVM knows about.
707 Unknown_FileType = 0, ///< Unrecognized file
708 Bitcode_FileType, ///< Bitcode file
709 Archive_FileType, ///< ar style archive file
710 ELF_Relocatable_FileType, ///< ELF Relocatable object file
711 ELF_Executable_FileType, ///< ELF Executable image
712 ELF_SharedObject_FileType, ///< ELF dynamically linked shared lib
713 ELF_Core_FileType, ///< ELF core image
714 Mach_O_Object_FileType, ///< Mach-O Object file
715 Mach_O_Executable_FileType, ///< Mach-O Executable
716 Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM
717 Mach_O_Core_FileType, ///< Mach-O Core File
718 Mach_O_PreloadExecutable_FileType, ///< Mach-O Preloaded Executable
719 Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib
720 Mach_O_DynamicLinker_FileType, ///< The Mach-O dynamic linker
721 Mach_O_Bundle_FileType, ///< Mach-O Bundle file
722 Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub
723 COFF_FileType ///< COFF object file or lib
726 /// This utility function allows any memory block to be examined in order
727 /// to determine its file type.
728 LLVMFileType IdentifyFileType(const char*magic, unsigned length);
730 /// This function can be used to copy the file specified by Src to the
731 /// file specified by Dest. If an error occurs, Dest is removed.
732 /// @returns true if an error occurs, false otherwise
733 /// @brief Copy one file to another.
734 bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg);
736 /// This is the OS-specific path separator: a colon on Unix or a semicolon
738 extern const char PathSeparator;