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"
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 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 std::string 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 static Path GetMainExecutable(const char *argv0, void *MainAddr);
169 /// This is one of the very few ways in which a path can be constructed
170 /// with a syntactically invalid name. The only *legal* invalid name is an
171 /// empty one. Other invalid names are not permitted. Empty paths are
172 /// provided so that they can be used to indicate null or error results in
173 /// other lib/System functionality.
174 /// @brief Construct an empty (and invalid) path.
176 Path(const Path &that) : path(that.path) {}
178 /// This constructor will accept a std::string as a path. No checking is
179 /// done on this path to determine if it is valid. To determine validity
180 /// of the path, use the isValid method.
181 /// @param p The path to assign.
182 /// @brief Construct a Path from a string.
183 explicit Path(const std::string& p) : path(p) {}
185 /// This constructor will accept a character range as a path. No checking
186 /// is done on this path to determine if it is valid. To determine
187 /// validity of the path, use the isValid method.
188 /// @param StrStart A pointer to the first character of the path name
189 /// @param StrLen The length of the path name at StrStart
190 /// @brief Construct a Path from a string.
191 explicit Path(const char *StrStart, unsigned StrLen)
192 : path(StrStart, StrStart+StrLen) {}
198 /// Makes a copy of \p that to \p this.
200 /// @brief Assignment Operator
201 Path &operator=(const Path &that) {
206 /// Compares \p this Path with \p that Path for equality.
207 /// @returns true if \p this and \p that refer to the same thing.
208 /// @brief Equality Operator
209 bool operator==(const Path &that) const {
210 return 0 == path.compare(that.path);
213 /// Compares \p this Path with \p that Path for inequality.
214 /// @returns true if \p this and \p that refer to different things.
215 /// @brief Inequality Operator
216 bool operator!=(const Path &that) const {
217 return 0 != path.compare(that.path);
220 /// Determines if \p this Path is less than \p that Path. This is required
221 /// so that Path objects can be placed into ordered collections (e.g.
222 /// std::map). The comparison is done lexicographically as defined by
223 /// the std::string::compare method.
224 /// @returns true if \p this path is lexicographically less than \p that.
225 /// @brief Less Than Operator
226 bool operator<(const Path& that) const {
227 return 0 > path.compare(that.path);
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 path and basename(up to and
274 /// including the last dot) of the file or directory name and
275 /// returns just the suffix. For example /a/foo.bar would cause
276 /// this function to return "bar".
277 /// @returns std::string containing the suffix of the path
278 /// @brief Get the suffix of the path
279 std::string getSuffix() const;
281 /// Obtain a 'C' string for the path name.
282 /// @returns a 'C' string containing the path name.
283 /// @brief Returns the path as a C string.
284 const char *c_str() const { return path.c_str(); }
286 /// size - Return the length in bytes of this path name.
287 unsigned size() const { return path.size(); }
290 /// @name Disk Accessors
293 /// This function determines if the path name in this object references
294 /// the root (top level directory) of the file system. The details of what
295 /// is considered the "root" may vary from system to system so this method
296 /// will do the necessary checking.
297 /// @returns true iff the path name references the root directory.
298 /// @brief Determines if the path references the root directory.
299 bool isRootDirectory() const;
301 /// This function determines if the path name is absolute, as opposed to
303 /// @brief Determine if the path is absolute.
304 bool isAbsolute() const;
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(const std::string& 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 /// @return strue if the file starts with the magid number for a native
342 /// @brief Determine if the path reference a dynamic library.
343 bool isDynamicLibrary() const;
345 /// This function determines if the path name references an existing file
346 /// or directory in the file system.
347 /// @returns true if the pathname references an existing file or
349 /// @brief Determines if the path is a file or directory in
353 /// This function determines if the path name refences an
354 /// existing directory.
355 /// @returns true if the pathname references an existing directory.
356 /// @brief Determins if the path is a directory in the file system.
357 bool isDirectory() const;
359 /// This function determines if the path name references a readable file
360 /// or directory in the file system. This function checks for
361 /// the existence and readability (by the current program) of the file
363 /// @returns true if the pathname references a readable file.
364 /// @brief Determines if the path is a readable file or directory
365 /// in the file system.
366 bool canRead() const;
368 /// This function determines if the path name references a writable file
369 /// or directory in the file system. This function checks for the
370 /// existence and writability (by the current program) of the file or
372 /// @returns true if the pathname references a writable file.
373 /// @brief Determines if the path is a writable file or directory
374 /// in the file system.
375 bool canWrite() const;
377 /// This function determines if the path name references an executable
378 /// file in the file system. This function checks for the existence and
379 /// executability (by the current program) of the file.
380 /// @returns true if the pathname references an executable file.
381 /// @brief Determines if the path is an executable file in the file
383 bool canExecute() const;
385 /// This function builds a list of paths that are the names of the
386 /// files and directories in a directory.
387 /// @returns true if an error occurs, true otherwise
388 /// @brief Build a list of directory's contents.
389 bool getDirectoryContents(
390 std::set<Path> &paths, ///< The resulting list of file & directory names
391 std::string* ErrMsg ///< Optional place to return an error message.
395 /// @name Path Mutators
398 /// The path name is cleared and becomes empty. This is an invalid
399 /// path name but is the *only* invalid path name. This is provided
400 /// so that path objects can be used to indicate the lack of a
401 /// valid path being found.
402 /// @brief Make the path empty.
403 void clear() { path.clear(); }
405 /// This method sets the Path object to \p unverified_path. This can fail
406 /// if the \p unverified_path does not pass the syntactic checks of the
407 /// isValid() method. If verification fails, the Path object remains
408 /// unchanged and false is returned. Otherwise true is returned and the
409 /// Path object takes on the path value of \p unverified_path
410 /// @returns true if the path was set, false otherwise.
411 /// @param unverified_path The path to be set in Path object.
412 /// @brief Set a full path from a std::string
413 bool set(const std::string& unverified_path);
415 /// One path component is removed from the Path. If only one component is
416 /// present in the path, the Path object becomes empty. If the Path object
417 /// is empty, no change is made.
418 /// @returns false if the path component could not be removed.
419 /// @brief Removes the last directory component of the Path.
420 bool eraseComponent();
422 /// The \p component is added to the end of the Path if it is a legal
423 /// name for the operating system. A directory separator will be added if
425 /// @returns false if the path component could not be added.
426 /// @brief Appends one path component to the Path.
427 bool appendComponent( const std::string& component );
429 /// A period and the \p suffix are appended to the end of the pathname.
430 /// The precondition for this function is that the Path reference a file
431 /// name (i.e. isFile() returns true). If the Path is not a file, no
432 /// action is taken and the function returns false. If the path would
433 /// become invalid for the host operating system, false is returned.
434 /// @returns false if the suffix could not be added, true if it was.
435 /// @brief Adds a period and the \p suffix to the end of the pathname.
436 bool appendSuffix(const std::string& suffix);
438 /// The suffix of the filename is erased. The suffix begins with and
439 /// includes the last . character in the filename after the last directory
440 /// separator and extends until the end of the name. If no . character is
441 /// after the last directory separator, then the file name is left
442 /// unchanged (i.e. it was already without a suffix) but the function
444 /// @returns false if there was no suffix to remove, true otherwise.
445 /// @brief Remove the suffix from a path name.
448 /// The current Path name is made unique in the file system. Upon return,
449 /// the Path will have been changed to make a unique file in the file
450 /// system or it will not have been changed if the current path name is
452 /// @throws std::string if an unrecoverable error occurs.
453 /// @brief Make the current path name unique in the file system.
454 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
457 /// @name Disk Mutators
460 /// This method attempts to make the file referenced by the Path object
461 /// available for reading so that the canRead() method will return true.
462 /// @brief Make the file readable;
463 bool makeReadableOnDisk(std::string* ErrMsg = 0);
465 /// This method attempts to make the file referenced by the Path object
466 /// available for writing so that the canWrite() method will return true.
467 /// @brief Make the file writable;
468 bool makeWriteableOnDisk(std::string* ErrMsg = 0);
470 /// This method attempts to make the file referenced by the Path object
471 /// available for execution so that the canExecute() method will return
473 /// @brief Make the file readable;
474 bool makeExecutableOnDisk(std::string* ErrMsg = 0);
476 /// This method allows the last modified time stamp and permission bits
477 /// to be set on the disk object referenced by the Path.
478 /// @throws std::string if an error occurs.
479 /// @returns true on error.
480 /// @brief Set the status information.
481 bool setStatusInfoOnDisk(const FileStatus &SI,
482 std::string *ErrStr = 0) const;
484 /// This method attempts to create a directory in the file system with the
485 /// same name as the Path object. The \p create_parents parameter controls
486 /// whether intermediate directories are created or not. if \p
487 /// create_parents is true, then an attempt will be made to create all
488 /// intermediate directories, as needed. If \p create_parents is false,
489 /// then only the final directory component of the Path name will be
490 /// created. The created directory will have no entries.
491 /// @returns true if the directory could not be created, false otherwise
492 /// @brief Create the directory this Path refers to.
493 bool createDirectoryOnDisk(
494 bool create_parents = false, ///< Determines whether non-existent
495 ///< directory components other than the last one (the "parents")
496 ///< are created or not.
497 std::string* ErrMsg = 0 ///< Optional place to put error messages.
500 /// This method attempts to create a file in the file system with the same
501 /// name as the Path object. The intermediate directories must all exist
502 /// at the time this method is called. Use createDirectoriesOnDisk to
503 /// accomplish that. The created file will be empty upon return from this
505 /// @returns true if the file could not be created, false otherwise.
506 /// @brief Create the file this Path refers to.
507 bool createFileOnDisk(
508 std::string* ErrMsg = 0 ///< Optional place to put error messages.
511 /// This is like createFile except that it creates a temporary file. A
512 /// unique temporary file name is generated based on the contents of
513 /// \p this before the call. The new name is assigned to \p this and the
514 /// file is created. Note that this will both change the Path object
515 /// *and* create the corresponding file. This function will ensure that
516 /// the newly generated temporary file name is unique in the file system.
517 /// @returns true if the file couldn't be created, false otherwise.
518 /// @brief Create a unique temporary file
519 bool createTemporaryFileOnDisk(
520 bool reuse_current = false, ///< When set to true, this parameter
521 ///< indicates that if the current file name does not exist then
522 ///< it will be used without modification.
523 std::string* ErrMsg = 0 ///< Optional place to put error messages
526 /// This method renames the file referenced by \p this as \p newName. The
527 /// file referenced by \p this must exist. The file referenced by
528 /// \p newName does not need to exist.
529 /// @returns true on error, false otherwise
530 /// @brief Rename one file as another.
531 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
533 /// This method attempts to destroy the file or directory named by the
534 /// last component of the Path. If the Path refers to a directory and the
535 /// \p destroy_contents is false, an attempt will be made to remove just
536 /// the directory (the final Path component). If \p destroy_contents is
537 /// true, an attempt will be made to remove the entire contents of the
538 /// directory, recursively. If the Path refers to a file, the
539 /// \p destroy_contents parameter is ignored.
540 /// @param destroy_contents Indicates whether the contents of a destroyed
541 /// @param Err An optional string to receive an error message.
542 /// directory should also be destroyed (recursively).
543 /// @returns false if the file/directory was destroyed, true on error.
544 /// @brief Removes the file or directory from the filesystem.
545 bool eraseFromDisk(bool destroy_contents = false,
546 std::string *Err = 0) const;
549 /// MapInFilePages - This is a low level system API to map in the file
550 /// that is currently opened as FD into the current processes' address
551 /// space for read only access. This function may return null on failure
552 /// or if the system cannot provide the following constraints:
553 /// 1) The pages must be valid after the FD is closed, until
554 /// UnMapFilePages is called.
555 /// 2) Any padding after the end of the file must be zero filled, if
557 /// 3) The pages must be contiguous.
559 /// This API is not intended for general use, clients should use
560 /// MemoryBuffer::getFile instead.
561 static const char *MapInFilePages(int FD, uint64_t FileSize);
563 /// UnMapFilePages - Free pages mapped into the current process by
566 /// This API is not intended for general use, clients should use
567 /// MemoryBuffer::getFile instead.
568 static void UnMapFilePages(const char *Base, uint64_t FileSize);
574 mutable std::string path; ///< Storage for the path name.
579 /// This class is identical to Path class except it allows you to obtain the
580 /// file status of the Path as well. The reason for the distinction is one of
581 /// efficiency. First, the file status requires additional space and the space
582 /// is incorporated directly into PathWithStatus without an additional malloc.
583 /// Second, obtaining status information is an expensive operation on most
584 /// operating systems so we want to be careful and explicity about where we
585 /// allow this operation in LLVM.
586 /// @brief Path with file status class.
587 class PathWithStatus : public Path {
588 /// @name Constructors
591 /// @brief Default constructor
592 PathWithStatus() : Path(), status(), fsIsValid(false) {}
594 /// @brief Copy constructor
595 PathWithStatus(const PathWithStatus &that)
596 : Path(static_cast<const Path&>(that)), status(that.status),
597 fsIsValid(that.fsIsValid) {}
599 /// This constructor allows construction from a Path object
600 /// @brief Path constructor
601 PathWithStatus(const Path &other)
602 : Path(other), status(), fsIsValid(false) {}
604 /// This constructor will accept a std::string as a path. No checking is
605 /// done on this path to determine if it is valid. To determine validity
606 /// of the path, use the isValid method.
607 /// @brief Construct a Path from a string.
608 explicit PathWithStatus(
609 const std::string& p ///< The path to assign.
610 ) : Path(p), status(), fsIsValid(false) {}
612 /// This constructor will accept a character range as a path. No checking
613 /// is done on this path to determine if it is valid. To determine
614 /// validity of the path, use the isValid method.
615 /// @brief Construct a Path from a string.
616 explicit PathWithStatus(
617 const char *StrStart, ///< Pointer to the first character of the path
618 unsigned StrLen ///< Length of the path.
619 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
621 /// Makes a copy of \p that to \p this.
623 /// @brief Assignment Operator
624 PathWithStatus &operator=(const PathWithStatus &that) {
625 static_cast<Path&>(*this) = static_cast<const Path&>(that);
626 status = that.status;
627 fsIsValid = that.fsIsValid;
631 /// Makes a copy of \p that to \p this.
633 /// @brief Assignment Operator
634 PathWithStatus &operator=(const Path &that) {
635 static_cast<Path&>(*this) = static_cast<const Path&>(that);
644 /// This function returns status information about the file. The type of
645 /// path (file or directory) is updated to reflect the actual contents
646 /// of the file system.
647 /// @returns 0 on failure, with Error explaining why (if non-zero)
648 /// @returns a pointer to a FileStatus structure on success.
649 /// @brief Get file status.
650 const FileStatus *getFileStatus(
651 bool forceUpdate = false, ///< Force an update from the file system
652 std::string *Error = 0 ///< Optional place to return an error msg.
659 mutable FileStatus status; ///< Status information.
660 mutable bool fsIsValid; ///< Whether we've obtained it or not
665 /// This enumeration delineates the kinds of files that LLVM knows about.
667 Unknown_FileType = 0, ///< Unrecognized file
668 Bitcode_FileType, ///< Bitcode file
669 Archive_FileType, ///< ar style archive file
670 ELF_Relocatable_FileType, ///< ELF Relocatable object file
671 ELF_Executable_FileType, ///< ELF Executable image
672 ELF_SharedObject_FileType, ///< ELF dynamically linked shared lib
673 ELF_Core_FileType, ///< ELF core image
674 Mach_O_Object_FileType, ///< Mach-O Object file
675 Mach_O_Executable_FileType, ///< Mach-O Executable
676 Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM
677 Mach_O_Core_FileType, ///< Mach-O Core File
678 Mach_O_PreloadExectuable_FileType, ///< Mach-O Preloaded Executable
679 Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib
680 Mach_O_DynamicLinker_FileType, ///< The Mach-O dynamic linker
681 Mach_O_Bundle_FileType, ///< Mach-O Bundle file
682 Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub
683 COFF_FileType ///< COFF object file or lib
686 /// This utility function allows any memory block to be examined in order
687 /// to determine its file type.
688 LLVMFileType IdentifyFileType(const char*magic, unsigned length);
690 /// This function can be used to copy the file specified by Src to the
691 /// file specified by Dest. If an error occurs, Dest is removed.
692 /// @returns true if an error occurs, false otherwise
693 /// @brief Copy one file to another.
694 bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg);
696 /// This is the OS-specific path separator: a colon on Unix or a semicolon
698 extern const char PathSeparator;
701 std::ostream& operator<<(std::ostream& strm, const sys::Path& aPath);
702 inline std::ostream& operator<<(std::ostream& strm,
703 const sys::PathWithStatus& aPath) {
704 strm << static_cast<const sys::Path&>(aPath);