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/ADT/StringRef.h"
18 #include "llvm/System/TimeValue.h"
26 /// This structure provides basic file system information about a file. It
27 /// is patterned after the stat(2) Unix operating system call but made
28 /// platform independent and eliminates many of the unix-specific fields.
29 /// However, to support llvm-ar, the mode, user, and group fields are
30 /// retained. These pertain to unix security and may not have a meaningful
31 /// value on non-Unix platforms. However, the other fields should
32 /// always be applicable on all platforms. The structure is filled in by
33 /// the PathWithStatus class.
34 /// @brief File status structure
37 uint64_t fileSize; ///< Size of the file in bytes
38 TimeValue modTime; ///< Time of file's modification
39 uint32_t mode; ///< Mode of the file, if applicable
40 uint32_t user; ///< User ID of owner, if applicable
41 uint32_t group; ///< Group ID of owner, if applicable
42 uint64_t uniqueID; ///< A number to uniquely ID this file
43 bool isDir : 1; ///< True if this is a directory.
44 bool isFile : 1; ///< True if this is a file.
46 FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
47 group(999), uniqueID(0), isDir(false), isFile(false) { }
49 TimeValue getTimestamp() const { return modTime; }
50 uint64_t getSize() const { return fileSize; }
51 uint32_t getMode() const { return mode; }
52 uint32_t getUser() const { return user; }
53 uint32_t getGroup() const { return group; }
54 uint64_t getUniqueID() const { return uniqueID; }
57 /// This class provides an abstraction for the path to a file or directory
58 /// in the operating system's filesystem and provides various basic operations
59 /// on it. Note that this class only represents the name of a path to a file
60 /// or directory which may or may not be valid for a given machine's file
61 /// system. The class is patterned after the java.io.File class with various
62 /// extensions and several omissions (not relevant to LLVM). A Path object
63 /// ensures that the path it encapsulates is syntactically valid for the
64 /// operating system it is running on but does not ensure correctness for
65 /// any particular file system. That is, a syntactically valid path might
66 /// specify path components that do not exist in the file system and using
67 /// such a Path to act on the file system could produce errors. There is one
68 /// invalid Path value which is permitted: the empty path. The class should
69 /// never allow a syntactically invalid non-empty path name to be assigned.
70 /// Empty paths are required in order to indicate an error result in some
71 /// situations. If the path is empty, the isValid operation will return
72 /// false. All operations will fail if isValid is false. Operations that
73 /// change the path will either return false if it would cause a syntactically
74 /// invalid path name (in which case the Path object is left unchanged) or
75 /// throw an std::string exception indicating the error. The methods are
76 /// grouped into four basic categories: Path Accessors (provide information
77 /// about the path without accessing disk), Disk Accessors (provide
78 /// information about the underlying file or directory), Path Mutators
79 /// (change the path information, not the disk), and Disk Mutators (change
80 /// the disk file/directory referenced by the path). The Disk Mutator methods
81 /// all have the word "disk" embedded in their method name to reinforce the
82 /// notion that the operation modifies the file system.
84 /// @brief An abstraction for operating system paths.
86 /// @name Constructors
89 /// Construct a path to the root directory of the file system. The root
90 /// directory is a top level directory above which there are no more
91 /// directories. For example, on UNIX, the root directory is /. On Windows
92 /// it is C:\. Other operating systems may have different notions of
93 /// what the root directory is or none at all. In that case, a consistent
94 /// default root directory will be used.
95 static Path GetRootDirectory();
97 /// Construct a path to a unique temporary directory that is created in
98 /// a "standard" place for the operating system. The directory is
99 /// guaranteed to be created on exit from this function. If the directory
100 /// cannot be created, the function will throw an exception.
101 /// @returns an invalid path (empty) on error
102 /// @param ErrMsg Optional place for an error message if an error occurs
103 /// @brief Constrct a path to an new, unique, existing temporary
105 static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
107 /// Construct a vector of sys::Path that contains the "standard" system
108 /// library paths suitable for linking into programs. This function *must*
109 /// return the value of LLVM_LIB_SEARCH_PATH as the first item in \p Paths
110 /// if that environment variable is set and it references a directory.
111 /// @brief Construct a path to the system library directory
112 static void GetSystemLibraryPaths(std::vector<sys::Path>& Paths);
114 /// Construct a vector of sys::Path that contains the "standard" bitcode
115 /// library paths suitable for linking into an llvm program. This function
116 /// *must* return the value of LLVM_LIB_SEARCH_PATH as well as the value
117 /// of LLVM_LIBDIR. It also must provide the System library paths as
118 /// returned by GetSystemLibraryPaths.
119 /// @see GetSystemLibraryPaths
120 /// @brief Construct a list of directories in which bitcode could be
122 static void GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths);
124 /// Find the path to a library using its short name. Use the system
125 /// dependent library paths to locate the library.
126 /// @brief Find a library.
127 static Path FindLibrary(std::string& short_name);
129 /// Construct a path to the default LLVM configuration directory. The
130 /// implementation must ensure that this is a well-known (same on many
131 /// systems) directory in which llvm configuration files exist. For
132 /// example, on Unix, the /etc/llvm directory has been selected.
133 /// @brief Construct a path to the default LLVM configuration directory
134 static Path GetLLVMDefaultConfigDir();
136 /// Construct a path to the LLVM installed configuration directory. The
137 /// implementation must ensure that this refers to the "etc" directory of
138 /// the LLVM installation. This is the location where configuration files
139 /// will be located for a particular installation of LLVM on a machine.
140 /// @brief Construct a path to the LLVM installed configuration directory
141 static Path GetLLVMConfigDir();
143 /// Construct a path to the current user's home directory. The
144 /// implementation must use an operating system specific mechanism for
145 /// determining the user's home directory. For example, the environment
146 /// variable "HOME" could be used on Unix. If a given operating system
147 /// does not have the concept of a user's home directory, this static
148 /// constructor must provide the same result as GetRootDirectory.
149 /// @brief Construct a path to the current user's "home" directory
150 static Path GetUserHomeDirectory();
152 /// Construct a path to the current directory for the current process.
153 /// @returns The current working directory.
154 /// @brief Returns the current working directory.
155 static Path GetCurrentDirectory();
157 /// Return the suffix commonly used on file names that contain a shared
158 /// object, shared archive, or dynamic link library. Such files are
159 /// linked at runtime into a process and their code images are shared
160 /// between processes.
161 /// @returns The dynamic link library suffix for the current platform.
162 /// @brief Return the dynamic link library suffix.
163 static StringRef GetDLLSuffix();
165 /// GetMainExecutable - Return the path to the main executable, given the
166 /// value of argv[0] from program startup and the address of main itself.
167 /// In extremis, this function may fail and return an empty path.
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 char* or std::string as a path. No
180 /// checking is done on this path to determine if it is valid. To
181 /// determine validity 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(StringRef 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 that A StringRef denoting the path
209 /// @brief Assignment Operator
210 Path &operator=(StringRef 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 { return !(*this == that); }
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 last component of the path name. The last
253 /// component is the file or directory name occuring after the last
254 /// directory separator. If no directory separator is present, the entire
255 /// path name is returned (i.e. same as toString).
256 /// @returns StringRef containing the last component of the path name.
257 /// @brief Returns the last component of the path name.
258 StringRef getLast() const;
260 /// This function strips off the path and suffix of the file or directory
261 /// name and returns just the basename. For example /a/foo.bar would cause
262 /// this function to return "foo".
263 /// @returns StringRef containing the basename of the path
264 /// @brief Get the base name of the path
265 StringRef getBasename() const;
267 /// This function strips off the suffix of the path beginning with the
268 /// path separator ('/' on Unix, '\' on Windows) and returns the result.
269 StringRef getDirname() const;
271 /// This function strips off the path and basename(up to and
272 /// including the last dot) of the file or directory name and
273 /// returns just the suffix. For example /a/foo.bar would cause
274 /// this function to return "bar".
275 /// @returns StringRef containing the suffix of the path
276 /// @brief Get the suffix of the path
277 StringRef getSuffix() const;
279 /// Obtain a 'C' string for the path name.
280 /// @returns a 'C' string containing the path name.
281 /// @brief Returns the path as a C string.
282 const char *c_str() const { return path.c_str(); }
283 const std::string &str() const { return path; }
286 /// size - Return the length in bytes of this path name.
287 size_t size() const { return path.size(); }
289 /// empty - Returns true if the path is empty.
290 unsigned empty() const { return path.empty(); }
293 /// @name Disk Accessors
296 /// This function determines if the path name is absolute, as opposed to
298 /// @brief Determine if the path is absolute.
299 bool isAbsolute() const;
301 /// This function determines if the path name is absolute, as opposed to
303 /// @brief Determine if the path is absolute.
304 static bool isAbsolute(const char *NameStart, unsigned NameLen);
306 /// This function opens the file associated with the path name provided by
307 /// the Path object and reads its magic number. If the magic number at the
308 /// start of the file matches \p magic, true is returned. In all other
309 /// cases (file not found, file not accessible, etc.) it returns false.
310 /// @returns true if the magic number of the file matches \p magic.
311 /// @brief Determine if file has a specific magic number
312 bool hasMagicNumber(StringRef magic) const;
314 /// This function retrieves the first \p len bytes of the file associated
315 /// with \p this. These bytes are returned as the "magic number" in the
316 /// \p Magic parameter.
317 /// @returns true if the Path is a file and the magic number is retrieved,
319 /// @brief Get the file's magic number.
320 bool getMagicNumber(std::string& Magic, unsigned len) const;
322 /// This function determines if the path name in the object references an
323 /// archive file by looking at its magic number.
324 /// @returns true if the file starts with the magic number for an archive
326 /// @brief Determine if the path references an archive file.
327 bool isArchive() const;
329 /// This function determines if the path name in the object references an
330 /// LLVM Bitcode file by looking at its magic number.
331 /// @returns true if the file starts with the magic number for LLVM
333 /// @brief Determine if the path references a bitcode file.
334 bool isBitcodeFile() const;
336 /// This function determines if the path name in the object references a
337 /// native Dynamic Library (shared library, shared object) by looking at
338 /// the file's magic number. The Path object must reference a file, not a
340 /// @returns true if the file starts with the magic number for a native
342 /// @brief Determine if the path references a dynamic library.
343 bool isDynamicLibrary() const;
345 /// This function determines if the path name in the object references a
346 /// native object file by looking at it's magic number. The term object
347 /// file is defined as "an organized collection of separate, named
348 /// sequences of binary data." This covers the obvious file formats such as
349 /// COFF and ELF, but it also includes llvm ir bitcode, archives,
350 /// libraries, etc...
351 /// @returns true if the file starts with the magic number for an object
353 /// @brief Determine if the path references an object file.
354 bool isObjectFile() const;
356 /// This function determines if the path name references an existing file
357 /// or directory in the file system.
358 /// @returns true if the pathname references an existing file or
360 /// @brief Determines if the path is a file or directory in
364 /// This function determines if the path name refences an
365 /// existing directory.
366 /// @returns true if the pathname references an existing directory.
367 /// @brief Determins if the path is a directory in the file system.
368 bool isDirectory() const;
370 /// This function determines if the path name references a readable file
371 /// or directory in the file system. This function checks for
372 /// the existence and readability (by the current program) of the file
374 /// @returns true if the pathname references a readable file.
375 /// @brief Determines if the path is a readable file or directory
376 /// in the file system.
377 bool canRead() const;
379 /// This function determines if the path name references a writable file
380 /// or directory in the file system. This function checks for the
381 /// existence and writability (by the current program) of the file or
383 /// @returns true if the pathname references a writable file.
384 /// @brief Determines if the path is a writable file or directory
385 /// in the file system.
386 bool canWrite() const;
388 /// This function checks that what we're trying to work only on a regular file.
389 /// Check for things like /dev/null, any block special file,
390 /// or other things that aren't "regular" regular files.
391 /// @returns true if the file is S_ISREG.
392 /// @brief Determines if the file is a regular file
393 bool isRegularFile() const;
395 /// This function determines if the path name references an executable
396 /// file in the file system. This function checks for the existence and
397 /// executability (by the current program) of the file.
398 /// @returns true if the pathname references an executable file.
399 /// @brief Determines if the path is an executable file in the file
401 bool canExecute() const;
403 /// This function builds a list of paths that are the names of the
404 /// files and directories in a directory.
405 /// @returns true if an error occurs, true otherwise
406 /// @brief Build a list of directory's contents.
407 bool getDirectoryContents(
408 std::set<Path> &paths, ///< The resulting list of file & directory names
409 std::string* ErrMsg ///< Optional place to return an error message.
413 /// @name Path Mutators
416 /// The path name is cleared and becomes empty. This is an invalid
417 /// path name but is the *only* invalid path name. This is provided
418 /// so that path objects can be used to indicate the lack of a
419 /// valid path being found.
420 /// @brief Make the path empty.
421 void clear() { path.clear(); }
423 /// This method sets the Path object to \p unverified_path. This can fail
424 /// if the \p unverified_path does not pass the syntactic checks of the
425 /// isValid() method. If verification fails, the Path object remains
426 /// unchanged and false is returned. Otherwise true is returned and the
427 /// Path object takes on the path value of \p unverified_path
428 /// @returns true if the path was set, false otherwise.
429 /// @param unverified_path The path to be set in Path object.
430 /// @brief Set a full path from a StringRef
431 bool set(StringRef unverified_path);
433 /// One path component is removed from the Path. If only one component is
434 /// present in the path, the Path object becomes empty. If the Path object
435 /// is empty, no change is made.
436 /// @returns false if the path component could not be removed.
437 /// @brief Removes the last directory component of the Path.
438 bool eraseComponent();
440 /// The \p component is added to the end of the Path if it is a legal
441 /// name for the operating system. A directory separator will be added if
443 /// @returns false if the path component could not be added.
444 /// @brief Appends one path component to the Path.
445 bool appendComponent(StringRef component);
447 /// A period and the \p suffix are appended to the end of the pathname.
448 /// The precondition for this function is that the Path reference a file
449 /// name (i.e. isFile() returns true). If the Path is not a file, no
450 /// action is taken and the function returns false. If the path would
451 /// become invalid for the host operating system, false is returned.
452 /// @returns false if the suffix could not be added, true if it was.
453 /// @brief Adds a period and the \p suffix to the end of the pathname.
454 bool appendSuffix(StringRef suffix);
456 /// The suffix of the filename is erased. The suffix begins with and
457 /// includes the last . character in the filename after the last directory
458 /// separator and extends until the end of the name. If no . character is
459 /// after the last directory separator, then the file name is left
460 /// unchanged (i.e. it was already without a suffix) but the function
462 /// @returns false if there was no suffix to remove, true otherwise.
463 /// @brief Remove the suffix from a path name.
466 /// The current Path name is made unique in the file system. Upon return,
467 /// the Path will have been changed to make a unique file in the file
468 /// system or it will not have been changed if the current path name is
470 /// @throws std::string if an unrecoverable error occurs.
471 /// @brief Make the current path name unique in the file system.
472 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
474 /// The current Path name is made absolute by prepending the
475 /// current working directory if necessary.
479 /// @name Disk Mutators
482 /// This method attempts to make the file referenced by the Path object
483 /// available for reading so that the canRead() method will return true.
484 /// @brief Make the file readable;
485 bool makeReadableOnDisk(std::string* ErrMsg = 0);
487 /// This method attempts to make the file referenced by the Path object
488 /// available for writing so that the canWrite() method will return true.
489 /// @brief Make the file writable;
490 bool makeWriteableOnDisk(std::string* ErrMsg = 0);
492 /// This method attempts to make the file referenced by the Path object
493 /// available for execution so that the canExecute() method will return
495 /// @brief Make the file readable;
496 bool makeExecutableOnDisk(std::string* ErrMsg = 0);
498 /// This method allows the last modified time stamp and permission bits
499 /// to be set on the disk object referenced by the Path.
500 /// @throws std::string if an error occurs.
501 /// @returns true on error.
502 /// @brief Set the status information.
503 bool setStatusInfoOnDisk(const FileStatus &SI,
504 std::string *ErrStr = 0) const;
506 /// This method attempts to create a directory in the file system with the
507 /// same name as the Path object. The \p create_parents parameter controls
508 /// whether intermediate directories are created or not. if \p
509 /// create_parents is true, then an attempt will be made to create all
510 /// intermediate directories, as needed. If \p create_parents is false,
511 /// then only the final directory component of the Path name will be
512 /// created. The created directory will have no entries.
513 /// @returns true if the directory could not be created, false otherwise
514 /// @brief Create the directory this Path refers to.
515 bool createDirectoryOnDisk(
516 bool create_parents = false, ///< Determines whether non-existent
517 ///< directory components other than the last one (the "parents")
518 ///< are created or not.
519 std::string* ErrMsg = 0 ///< Optional place to put error messages.
522 /// This method attempts to create a file in the file system with the same
523 /// name as the Path object. The intermediate directories must all exist
524 /// at the time this method is called. Use createDirectoriesOnDisk to
525 /// accomplish that. The created file will be empty upon return from this
527 /// @returns true if the file could not be created, false otherwise.
528 /// @brief Create the file this Path refers to.
529 bool createFileOnDisk(
530 std::string* ErrMsg = 0 ///< Optional place to put error messages.
533 /// This is like createFile except that it creates a temporary file. A
534 /// unique temporary file name is generated based on the contents of
535 /// \p this before the call. The new name is assigned to \p this and the
536 /// file is created. Note that this will both change the Path object
537 /// *and* create the corresponding file. This function will ensure that
538 /// the newly generated temporary file name is unique in the file system.
539 /// @returns true if the file couldn't be created, false otherwise.
540 /// @brief Create a unique temporary file
541 bool createTemporaryFileOnDisk(
542 bool reuse_current = false, ///< When set to true, this parameter
543 ///< indicates that if the current file name does not exist then
544 ///< it will be used without modification.
545 std::string* ErrMsg = 0 ///< Optional place to put error messages
548 /// This method renames the file referenced by \p this as \p newName. The
549 /// file referenced by \p this must exist. The file referenced by
550 /// \p newName does not need to exist.
551 /// @returns true on error, false otherwise
552 /// @brief Rename one file as another.
553 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
555 /// This method attempts to destroy the file or directory named by the
556 /// last component of the Path. If the Path refers to a directory and the
557 /// \p destroy_contents is false, an attempt will be made to remove just
558 /// the directory (the final Path component). If \p destroy_contents is
559 /// true, an attempt will be made to remove the entire contents of the
560 /// directory, recursively. If the Path refers to a file, the
561 /// \p destroy_contents parameter is ignored.
562 /// @param destroy_contents Indicates whether the contents of a destroyed
563 /// @param Err An optional string to receive an error message.
564 /// directory should also be destroyed (recursively).
565 /// @returns false if the file/directory was destroyed, true on error.
566 /// @brief Removes the file or directory from the filesystem.
567 bool eraseFromDisk(bool destroy_contents = false,
568 std::string *Err = 0) const;
571 /// MapInFilePages - This is a low level system API to map in the file
572 /// that is currently opened as FD into the current processes' address
573 /// space for read only access. This function may return null on failure
574 /// or if the system cannot provide the following constraints:
575 /// 1) The pages must be valid after the FD is closed, until
576 /// UnMapFilePages is called.
577 /// 2) Any padding after the end of the file must be zero filled, if
579 /// 3) The pages must be contiguous.
581 /// This API is not intended for general use, clients should use
582 /// MemoryBuffer::getFile instead.
583 static const char *MapInFilePages(int FD, uint64_t FileSize);
585 /// UnMapFilePages - Free pages mapped into the current process by
588 /// This API is not intended for general use, clients should use
589 /// MemoryBuffer::getFile instead.
590 static void UnMapFilePages(const char *Base, uint64_t FileSize);
596 // Our win32 implementation relies on this string being mutable.
597 mutable std::string path; ///< Storage for the path name.
603 /// This class is identical to Path class except it allows you to obtain the
604 /// file status of the Path as well. The reason for the distinction is one of
605 /// efficiency. First, the file status requires additional space and the space
606 /// is incorporated directly into PathWithStatus without an additional malloc.
607 /// Second, obtaining status information is an expensive operation on most
608 /// operating systems so we want to be careful and explicity about where we
609 /// allow this operation in LLVM.
610 /// @brief Path with file status class.
611 class PathWithStatus : public Path {
612 /// @name Constructors
615 /// @brief Default constructor
616 PathWithStatus() : Path(), status(), fsIsValid(false) {}
618 /// @brief Copy constructor
619 PathWithStatus(const PathWithStatus &that)
620 : Path(static_cast<const Path&>(that)), status(that.status),
621 fsIsValid(that.fsIsValid) {}
623 /// This constructor allows construction from a Path object
624 /// @brief Path constructor
625 PathWithStatus(const Path &other)
626 : Path(other), status(), fsIsValid(false) {}
628 /// This constructor will accept a char* or std::string as a path. No
629 /// checking is done on this path to determine if it is valid. To
630 /// determine validity of the path, use the isValid method.
631 /// @brief Construct a Path from a string.
632 explicit PathWithStatus(
633 StringRef p ///< The path to assign.
634 ) : Path(p), status(), fsIsValid(false) {}
636 /// This constructor will accept a character range as a path. No checking
637 /// is done on this path to determine if it is valid. To determine
638 /// validity of the path, use the isValid method.
639 /// @brief Construct a Path from a string.
640 explicit PathWithStatus(
641 const char *StrStart, ///< Pointer to the first character of the path
642 unsigned StrLen ///< Length of the path.
643 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
645 /// Makes a copy of \p that to \p this.
647 /// @brief Assignment Operator
648 PathWithStatus &operator=(const PathWithStatus &that) {
649 static_cast<Path&>(*this) = static_cast<const Path&>(that);
650 status = that.status;
651 fsIsValid = that.fsIsValid;
655 /// Makes a copy of \p that to \p this.
657 /// @brief Assignment Operator
658 PathWithStatus &operator=(const Path &that) {
659 static_cast<Path&>(*this) = static_cast<const Path&>(that);
668 /// This function returns status information about the file. The type of
669 /// path (file or directory) is updated to reflect the actual contents
670 /// of the file system.
671 /// @returns 0 on failure, with Error explaining why (if non-zero)
672 /// @returns a pointer to a FileStatus structure on success.
673 /// @brief Get file status.
674 const FileStatus *getFileStatus(
675 bool forceUpdate = false, ///< Force an update from the file system
676 std::string *Error = 0 ///< Optional place to return an error msg.
683 mutable FileStatus status; ///< Status information.
684 mutable bool fsIsValid; ///< Whether we've obtained it or not
689 /// This enumeration delineates the kinds of files that LLVM knows about.
691 Unknown_FileType = 0, ///< Unrecognized file
692 Bitcode_FileType, ///< Bitcode file
693 Archive_FileType, ///< ar style archive file
694 ELF_Relocatable_FileType, ///< ELF Relocatable object file
695 ELF_Executable_FileType, ///< ELF Executable image
696 ELF_SharedObject_FileType, ///< ELF dynamically linked shared lib
697 ELF_Core_FileType, ///< ELF core image
698 Mach_O_Object_FileType, ///< Mach-O Object file
699 Mach_O_Executable_FileType, ///< Mach-O Executable
700 Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM
701 Mach_O_Core_FileType, ///< Mach-O Core File
702 Mach_O_PreloadExectuable_FileType, ///< Mach-O Preloaded Executable
703 Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib
704 Mach_O_DynamicLinker_FileType, ///< The Mach-O dynamic linker
705 Mach_O_Bundle_FileType, ///< Mach-O Bundle file
706 Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub
707 COFF_FileType ///< COFF object file or lib
710 /// This utility function allows any memory block to be examined in order
711 /// to determine its file type.
712 LLVMFileType IdentifyFileType(const char*magic, unsigned length);
714 /// This function can be used to copy the file specified by Src to the
715 /// file specified by Dest. If an error occurs, Dest is removed.
716 /// @returns true if an error occurs, false otherwise
717 /// @brief Copy one file to another.
718 bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg);
720 /// This is the OS-specific path separator: a colon on Unix or a semicolon
722 extern const char PathSeparator;