LLVM API Documentation

Path.h

Go to the documentation of this file.
00001 //===- llvm/System/Path.h - Path Operating System Concept -------*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file declares the llvm::sys::Path class.
00011 //
00012 //===----------------------------------------------------------------------===//
00013 
00014 #ifndef LLVM_SYSTEM_PATH_H
00015 #define LLVM_SYSTEM_PATH_H
00016 
00017 #include "llvm/System/TimeValue.h"
00018 #include "llvm/Support/raw_ostream.h"
00019 #include <set>
00020 #include <string>
00021 #include <vector>
00022 #include <iosfwd>
00023 
00024 namespace llvm {
00025 namespace sys {
00026 
00027   /// This structure provides basic file system information about a file. It
00028   /// is patterned after the stat(2) Unix operating system call but made
00029   /// platform independent and eliminates many of the unix-specific fields.
00030   /// However, to support llvm-ar, the mode, user, and group fields are
00031   /// retained. These pertain to unix security and may not have a meaningful
00032   /// value on non-Unix platforms. However, the other fields fields should
00033   /// always be applicable on all platforms.  The structure is filled in by
00034   /// the PathWithStatus class.
00035   /// @brief File status structure
00036   class FileStatus {
00037   public:
00038     uint64_t    fileSize;   ///< Size of the file in bytes
00039     TimeValue   modTime;    ///< Time of file's modification
00040     uint32_t    mode;       ///< Mode of the file, if applicable
00041     uint32_t    user;       ///< User ID of owner, if applicable
00042     uint32_t    group;      ///< Group ID of owner, if applicable
00043     uint64_t    uniqueID;   ///< A number to uniquely ID this file
00044     bool        isDir  : 1; ///< True if this is a directory.
00045     bool        isFile : 1; ///< True if this is a file.
00046 
00047     FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999),
00048                    group(999), uniqueID(0), isDir(false), isFile(false) { }
00049 
00050     TimeValue getTimestamp() const { return modTime; }
00051     uint64_t getSize() const { return fileSize; }
00052     uint32_t getMode() const { return mode; }
00053     uint32_t getUser() const { return user; }
00054     uint32_t getGroup() const { return group; }
00055     uint64_t getUniqueID() const { return uniqueID; }
00056   };
00057 
00058   /// This class provides an abstraction for the path to a file or directory
00059   /// in the operating system's filesystem and provides various basic operations
00060   /// on it.  Note that this class only represents the name of a path to a file
00061   /// or directory which may or may not be valid for a given machine's file
00062   /// system. The class is patterned after the java.io.File class with various
00063   /// extensions and several omissions (not relevant to LLVM).  A Path object
00064   /// ensures that the path it encapsulates is syntactically valid for the
00065   /// operating system it is running on but does not ensure correctness for
00066   /// any particular file system. That is, a syntactically valid path might
00067   /// specify path components that do not exist in the file system and using
00068   /// such a Path to act on the file system could produce errors. There is one
00069   /// invalid Path value which is permitted: the empty path.  The class should
00070   /// never allow a syntactically invalid non-empty path name to be assigned.
00071   /// Empty paths are required in order to indicate an error result in some
00072   /// situations. If the path is empty, the isValid operation will return
00073   /// false. All operations will fail if isValid is false. Operations that
00074   /// change the path will either return false if it would cause a syntactically
00075   /// invalid path name (in which case the Path object is left unchanged) or
00076   /// throw an std::string exception indicating the error. The methods are
00077   /// grouped into four basic categories: Path Accessors (provide information
00078   /// about the path without accessing disk), Disk Accessors (provide
00079   /// information about the underlying file or directory), Path Mutators
00080   /// (change the path information, not the disk), and Disk Mutators (change
00081   /// the disk file/directory referenced by the path). The Disk Mutator methods
00082   /// all have the word "disk" embedded in their method name to reinforce the
00083   /// notion that the operation modifies the file system.
00084   /// @since 1.4
00085   /// @brief An abstraction for operating system paths.
00086   class Path {
00087     /// @name Constructors
00088     /// @{
00089     public:
00090       /// Construct a path to the root directory of the file system. The root
00091       /// directory is a top level directory above which there are no more
00092       /// directories. For example, on UNIX, the root directory is /. On Windows
00093       /// it is C:\. Other operating systems may have different notions of
00094       /// what the root directory is or none at all. In that case, a consistent
00095       /// default root directory will be used.
00096       static Path GetRootDirectory();
00097 
00098       /// Construct a path to a unique temporary directory that is created in
00099       /// a "standard" place for the operating system. The directory is
00100       /// guaranteed to be created on exit from this function. If the directory
00101       /// cannot be created, the function will throw an exception.
00102       /// @returns an invalid path (empty) on error
00103       /// @param ErrMsg Optional place for an error message if an error occurs
00104       /// @brief Constrct a path to an new, unique, existing temporary
00105       /// directory.
00106       static Path GetTemporaryDirectory(std::string* ErrMsg = 0);
00107 
00108       /// Construct a vector of sys::Path that contains the "standard" system
00109       /// library paths suitable for linking into programs. This function *must*
00110       /// return the value of LLVM_LIB_SEARCH_PATH as the first item in \p Paths
00111       /// if that environment variable is set and it references a directory.
00112       /// @brief Construct a path to the system library directory
00113       static void GetSystemLibraryPaths(std::vector<sys::Path>& Paths);
00114 
00115       /// Construct a vector of sys::Path that contains the "standard" bitcode
00116       /// library paths suitable for linking into an llvm program. This function
00117       /// *must* return the value of LLVM_LIB_SEARCH_PATH as well as the value
00118       /// of LLVM_LIBDIR. It also must provide the System library paths as
00119       /// returned by GetSystemLibraryPaths.
00120       /// @see GetSystemLibraryPaths
00121       /// @brief Construct a list of directories in which bitcode could be
00122       /// found.
00123       static void GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths);
00124 
00125       /// Find the path to a library using its short name. Use the system
00126       /// dependent library paths to locate the library.
00127       /// @brief Find a library.
00128       static Path FindLibrary(std::string& short_name);
00129 
00130       /// Construct a path to the default LLVM configuration directory. The
00131       /// implementation must ensure that this is a well-known (same on many
00132       /// systems) directory in which llvm configuration files exist. For
00133       /// example, on Unix, the /etc/llvm directory has been selected.
00134       /// @brief Construct a path to the default LLVM configuration directory
00135       static Path GetLLVMDefaultConfigDir();
00136 
00137       /// Construct a path to the LLVM installed configuration directory. The
00138       /// implementation must ensure that this refers to the "etc" directory of
00139       /// the LLVM installation. This is the location where configuration files
00140       /// will be located for a particular installation of LLVM on a machine.
00141       /// @brief Construct a path to the LLVM installed configuration directory
00142       static Path GetLLVMConfigDir();
00143 
00144       /// Construct a path to the current user's home directory. The
00145       /// implementation must use an operating system specific mechanism for
00146       /// determining the user's home directory. For example, the environment
00147       /// variable "HOME" could be used on Unix. If a given operating system
00148       /// does not have the concept of a user's home directory, this static
00149       /// constructor must provide the same result as GetRootDirectory.
00150       /// @brief Construct a path to the current user's "home" directory
00151       static Path GetUserHomeDirectory();
00152 
00153       /// Construct a path to the current directory for the current process.
00154       /// @returns The current working directory.
00155       /// @brief Returns the current working directory.
00156       static Path GetCurrentDirectory();
00157 
00158       /// Return the suffix commonly used on file names that contain a shared
00159       /// object, shared archive, or dynamic link library. Such files are
00160       /// linked at runtime into a process and their code images are shared
00161       /// between processes.
00162       /// @returns The dynamic link library suffix for the current platform.
00163       /// @brief Return the dynamic link library suffix.
00164       static std::string GetDLLSuffix();
00165 
00166       /// GetMainExecutable - Return the path to the main executable, given the
00167       /// value of argv[0] from program startup and the address of main itself.
00168       static Path GetMainExecutable(const char *argv0, void *MainAddr);
00169 
00170       /// This is one of the very few ways in which a path can be constructed
00171       /// with a syntactically invalid name. The only *legal* invalid name is an
00172       /// empty one. Other invalid names are not permitted. Empty paths are
00173       /// provided so that they can be used to indicate null or error results in
00174       /// other lib/System functionality.
00175       /// @brief Construct an empty (and invalid) path.
00176       Path() : path() {}
00177       Path(const Path &that) : path(that.path) {}
00178 
00179       /// This constructor will accept a std::string as a path. No checking is
00180       /// done on this path to determine if it is valid. To determine validity
00181       /// of the path, use the isValid method.
00182       /// @param p The path to assign.
00183       /// @brief Construct a Path from a string.
00184       explicit Path(const std::string& p);
00185 
00186       /// This constructor will accept a character range as a path.  No checking
00187       /// is done on this path to determine if it is valid.  To determine
00188       /// validity of the path, use the isValid method.
00189       /// @param StrStart A pointer to the first character of the path name
00190       /// @param StrLen The length of the path name at StrStart
00191       /// @brief Construct a Path from a string.
00192       Path(const char *StrStart, unsigned StrLen);
00193 
00194     /// @}
00195     /// @name Operators
00196     /// @{
00197     public:
00198       /// Makes a copy of \p that to \p this.
00199       /// @returns \p this
00200       /// @brief Assignment Operator
00201       Path &operator=(const Path &that) {
00202         path = that.path;
00203         return *this;
00204       }
00205 
00206       /// Makes a copy of \p that to \p this.
00207       /// @param \p that A std::string denoting the path
00208       /// @returns \p this
00209       /// @brief Assignment Operator
00210       Path &operator=(const std::string &that);
00211 
00212       /// Compares \p this Path with \p that Path for equality.
00213       /// @returns true if \p this and \p that refer to the same thing.
00214       /// @brief Equality Operator
00215       bool operator==(const Path &that) const;
00216 
00217       /// Compares \p this Path with \p that Path for inequality.
00218       /// @returns true if \p this and \p that refer to different things.
00219       /// @brief Inequality Operator
00220       bool operator!=(const Path &that) const;
00221 
00222       /// Determines if \p this Path is less than \p that Path. This is required
00223       /// so that Path objects can be placed into ordered collections (e.g.
00224       /// std::map). The comparison is done lexicographically as defined by
00225       /// the std::string::compare method.
00226       /// @returns true if \p this path is lexicographically less than \p that.
00227       /// @brief Less Than Operator
00228       bool operator<(const Path& that) const;
00229 
00230     /// @}
00231     /// @name Path Accessors
00232     /// @{
00233     public:
00234       /// This function will use an operating system specific algorithm to
00235       /// determine if the current value of \p this is a syntactically valid
00236       /// path name for the operating system. The path name does not need to
00237       /// exist, validity is simply syntactical. Empty paths are always invalid.
00238       /// @returns true iff the path name is syntactically legal for the
00239       /// host operating system.
00240       /// @brief Determine if a path is syntactically valid or not.
00241       bool isValid() const;
00242 
00243       /// This function determines if the contents of the path name are empty.
00244       /// That is, the path name has a zero length. This does NOT determine if
00245       /// if the file is empty. To get the length of the file itself, Use the
00246       /// PathWithStatus::getFileStatus() method and then the getSize() method
00247       /// on the returned FileStatus object.
00248       /// @returns true iff the path is empty.
00249       /// @brief Determines if the path name is empty (invalid).
00250       bool isEmpty() const { return path.empty(); }
00251 
00252       /// This function returns the current contents of the path as a
00253       /// std::string. This allows the underlying path string to be manipulated.
00254       /// @returns std::string containing the path name.
00255       /// @brief Returns the path as a std::string.
00256       const std::string &toString() const { return path; }
00257 
00258       /// This function returns the last component of the path name. The last
00259       /// component is the file or directory name occuring after the last
00260       /// directory separator. If no directory separator is present, the entire
00261       /// path name is returned (i.e. same as toString).
00262       /// @returns std::string containing the last component of the path name.
00263       /// @brief Returns the last component of the path name.
00264       std::string getLast() const;
00265 
00266       /// This function strips off the path and suffix of the file or directory
00267       /// name and returns just the basename. For example /a/foo.bar would cause
00268       /// this function to return "foo".
00269       /// @returns std::string containing the basename of the path
00270       /// @brief Get the base name of the path
00271       std::string getBasename() const;
00272 
00273       /// This function strips off the suffix of the path beginning with the
00274       /// path separator ('/' on Unix, '\' on Windows) and returns the result.
00275       std::string getDirname() const;
00276 
00277       /// This function strips off the path and basename(up to and
00278       /// including the last dot) of the file or directory name and
00279       /// returns just the suffix. For example /a/foo.bar would cause
00280       /// this function to return "bar".
00281       /// @returns std::string containing the suffix of the path
00282       /// @brief Get the suffix of the path
00283       std::string getSuffix() const;
00284 
00285       /// Obtain a 'C' string for the path name.
00286       /// @returns a 'C' string containing the path name.
00287       /// @brief Returns the path as a C string.
00288       const char *c_str() const { return path.c_str(); }
00289 
00290       /// size - Return the length in bytes of this path name.
00291       size_t size() const { return path.size(); }
00292 
00293       /// empty - Returns true if the path is empty.
00294       unsigned empty() const { return path.empty(); }
00295 
00296     /// @}
00297     /// @name Disk Accessors
00298     /// @{
00299     public:
00300       /// This function determines if the path name in this object references
00301       /// the root (top level directory) of the file system. The details of what
00302       /// is considered the "root" may vary from system to system so this method
00303       /// will do the necessary checking.
00304       /// @returns true iff the path name references the root directory.
00305       /// @brief Determines if the path references the root directory.
00306       bool isRootDirectory() const;
00307 
00308       /// This function determines if the path name is absolute, as opposed to
00309       /// relative.
00310       /// @brief Determine if the path is absolute.
00311       bool isAbsolute() const;
00312 
00313       /// This function determines if the path name is absolute, as opposed to
00314       /// relative.
00315       /// @brief Determine if the path is absolute.
00316       static bool isAbsolute(const char *NameStart, unsigned NameLen);
00317 
00318       /// This function opens the file associated with the path name provided by
00319       /// the Path object and reads its magic number. If the magic number at the
00320       /// start of the file matches \p magic, true is returned. In all other
00321       /// cases (file not found, file not accessible, etc.) it returns false.
00322       /// @returns true if the magic number of the file matches \p magic.
00323       /// @brief Determine if file has a specific magic number
00324       bool hasMagicNumber(const std::string& magic) const;
00325 
00326       /// This function retrieves the first \p len bytes of the file associated
00327       /// with \p this. These bytes are returned as the "magic number" in the
00328       /// \p Magic parameter.
00329       /// @returns true if the Path is a file and the magic number is retrieved,
00330       /// false otherwise.
00331       /// @brief Get the file's magic number.
00332       bool getMagicNumber(std::string& Magic, unsigned len) const;
00333 
00334       /// This function determines if the path name in the object references an
00335       /// archive file by looking at its magic number.
00336       /// @returns true if the file starts with the magic number for an archive
00337       /// file.
00338       /// @brief Determine if the path references an archive file.
00339       bool isArchive() const;
00340 
00341       /// This function determines if the path name in the object references an
00342       /// LLVM Bitcode file by looking at its magic number.
00343       /// @returns true if the file starts with the magic number for LLVM
00344       /// bitcode files.
00345       /// @brief Determine if the path references a bitcode file.
00346       bool isBitcodeFile() const;
00347 
00348       /// This function determines if the path name in the object references a
00349       /// native Dynamic Library (shared library, shared object) by looking at
00350       /// the file's magic number. The Path object must reference a file, not a
00351       /// directory.
00352       /// @return strue if the file starts with the magid number for a native
00353       /// shared library.
00354       /// @brief Determine if the path reference a dynamic library.
00355       bool isDynamicLibrary() const;
00356 
00357       /// This function determines if the path name references an existing file
00358       /// or directory in the file system.
00359       /// @returns true if the pathname references an existing file or
00360       /// directory.
00361       /// @brief Determines if the path is a file or directory in
00362       /// the file system.
00363       bool exists() const;
00364 
00365       /// This function determines if the path name refences an
00366       /// existing directory.
00367       /// @returns true if the pathname references an existing directory.
00368       /// @brief Determins if the path is a directory in the file system.
00369       bool isDirectory() const;
00370 
00371       /// This function determines if the path name references a readable file
00372       /// or directory in the file system. This function checks for
00373       /// the existence and readability (by the current program) of the file
00374       /// or directory.
00375       /// @returns true if the pathname references a readable file.
00376       /// @brief Determines if the path is a readable file or directory
00377       /// in the file system.
00378       bool canRead() const;
00379 
00380       /// This function determines if the path name references a writable file
00381       /// or directory in the file system. This function checks for the
00382       /// existence and writability (by the current program) of the file or
00383       /// directory.
00384       /// @returns true if the pathname references a writable file.
00385       /// @brief Determines if the path is a writable file or directory
00386       /// in the file system.
00387       bool canWrite() const;
00388 
00389       /// This function determines if the path name references an executable
00390       /// file in the file system. This function checks for the existence and
00391       /// executability (by the current program) of the file.
00392       /// @returns true if the pathname references an executable file.
00393       /// @brief Determines if the path is an executable file in the file
00394       /// system.
00395       bool canExecute() const;
00396 
00397       /// This function builds a list of paths that are the names of the
00398       /// files and directories in a directory.
00399       /// @returns true if an error occurs, true otherwise
00400       /// @brief Build a list of directory's contents.
00401       bool getDirectoryContents(
00402         std::set<Path> &paths, ///< The resulting list of file & directory names
00403         std::string* ErrMsg    ///< Optional place to return an error message.
00404       ) const;
00405 
00406     /// @}
00407     /// @name Path Mutators
00408     /// @{
00409     public:
00410       /// The path name is cleared and becomes empty. This is an invalid
00411       /// path name but is the *only* invalid path name. This is provided
00412       /// so that path objects can be used to indicate the lack of a
00413       /// valid path being found.
00414       /// @brief Make the path empty.
00415       void clear() { path.clear(); }
00416 
00417       /// This method sets the Path object to \p unverified_path. This can fail
00418       /// if the \p unverified_path does not pass the syntactic checks of the
00419       /// isValid() method. If verification fails, the Path object remains
00420       /// unchanged and false is returned. Otherwise true is returned and the
00421       /// Path object takes on the path value of \p unverified_path
00422       /// @returns true if the path was set, false otherwise.
00423       /// @param unverified_path The path to be set in Path object.
00424       /// @brief Set a full path from a std::string
00425       bool set(const std::string& unverified_path);
00426 
00427       /// One path component is removed from the Path. If only one component is
00428       /// present in the path, the Path object becomes empty. If the Path object
00429       /// is empty, no change is made.
00430       /// @returns false if the path component could not be removed.
00431       /// @brief Removes the last directory component of the Path.
00432       bool eraseComponent();
00433 
00434       /// The \p component is added to the end of the Path if it is a legal
00435       /// name for the operating system. A directory separator will be added if
00436       /// needed.
00437       /// @returns false if the path component could not be added.
00438       /// @brief Appends one path component to the Path.
00439       bool appendComponent( const std::string& component );
00440 
00441       /// A period and the \p suffix are appended to the end of the pathname.
00442       /// The precondition for this function is that the Path reference a file
00443       /// name (i.e. isFile() returns true). If the Path is not a file, no
00444       /// action is taken and the function returns false. If the path would
00445       /// become invalid for the host operating system, false is returned.
00446       /// @returns false if the suffix could not be added, true if it was.
00447       /// @brief Adds a period and the \p suffix to the end of the pathname.
00448       bool appendSuffix(const std::string& suffix);
00449 
00450       /// The suffix of the filename is erased. The suffix begins with and
00451       /// includes the last . character in the filename after the last directory
00452       /// separator and extends until the end of the name. If no . character is
00453       /// after the last directory separator, then the file name is left
00454       /// unchanged (i.e. it was already without a suffix) but the function
00455       /// returns false.
00456       /// @returns false if there was no suffix to remove, true otherwise.
00457       /// @brief Remove the suffix from a path name.
00458       bool eraseSuffix();
00459 
00460       /// The current Path name is made unique in the file system. Upon return,
00461       /// the Path will have been changed to make a unique file in the file
00462       /// system or it will not have been changed if the current path name is
00463       /// already unique.
00464       /// @throws std::string if an unrecoverable error occurs.
00465       /// @brief Make the current path name unique in the file system.
00466       bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg );
00467 
00468       /// The current Path name is made absolute by prepending the
00469       /// current working directory if necessary.
00470       void makeAbsolute();
00471 
00472     /// @}
00473     /// @name Disk Mutators
00474     /// @{
00475     public:
00476       /// This method attempts to make the file referenced by the Path object
00477       /// available for reading so that the canRead() method will return true.
00478       /// @brief Make the file readable;
00479       bool makeReadableOnDisk(std::string* ErrMsg = 0);
00480 
00481       /// This method attempts to make the file referenced by the Path object
00482       /// available for writing so that the canWrite() method will return true.
00483       /// @brief Make the file writable;
00484       bool makeWriteableOnDisk(std::string* ErrMsg = 0);
00485 
00486       /// This method attempts to make the file referenced by the Path object
00487       /// available for execution so that the canExecute() method will return
00488       /// true.
00489       /// @brief Make the file readable;
00490       bool makeExecutableOnDisk(std::string* ErrMsg = 0);
00491 
00492       /// This method allows the last modified time stamp and permission bits
00493       /// to be set on the disk object referenced by the Path.
00494       /// @throws std::string if an error occurs.
00495       /// @returns true on error.
00496       /// @brief Set the status information.
00497       bool setStatusInfoOnDisk(const FileStatus &SI,
00498                                std::string *ErrStr = 0) const;
00499 
00500       /// This method attempts to create a directory in the file system with the
00501       /// same name as the Path object. The \p create_parents parameter controls
00502       /// whether intermediate directories are created or not. if \p
00503       /// create_parents is true, then an attempt will be made to create all
00504       /// intermediate directories, as needed. If \p create_parents is false,
00505       /// then only the final directory component of the Path name will be
00506       /// created. The created directory will have no entries.
00507       /// @returns true if the directory could not be created, false otherwise
00508       /// @brief Create the directory this Path refers to.
00509       bool createDirectoryOnDisk(
00510         bool create_parents = false, ///<  Determines whether non-existent
00511            ///< directory components other than the last one (the "parents")
00512            ///< are created or not.
00513         std::string* ErrMsg = 0 ///< Optional place to put error messages.
00514       );
00515 
00516       /// This method attempts to create a file in the file system with the same
00517       /// name as the Path object. The intermediate directories must all exist
00518       /// at the time this method is called. Use createDirectoriesOnDisk to
00519       /// accomplish that. The created file will be empty upon return from this
00520       /// function.
00521       /// @returns true if the file could not be created, false otherwise.
00522       /// @brief Create the file this Path refers to.
00523       bool createFileOnDisk(
00524         std::string* ErrMsg = 0 ///< Optional place to put error messages.
00525       );
00526 
00527       /// This is like createFile except that it creates a temporary file. A
00528       /// unique temporary file name is generated based on the contents of
00529       /// \p this before the call. The new name is assigned to \p this and the
00530       /// file is created.  Note that this will both change the Path object
00531       /// *and* create the corresponding file. This function will ensure that
00532       /// the newly generated temporary file name is unique in the file system.
00533       /// @returns true if the file couldn't be created, false otherwise.
00534       /// @brief Create a unique temporary file
00535       bool createTemporaryFileOnDisk(
00536         bool reuse_current = false, ///< When set to true, this parameter
00537           ///< indicates that if the current file name does not exist then
00538           ///< it will be used without modification.
00539         std::string* ErrMsg = 0 ///< Optional place to put error messages
00540       );
00541 
00542       /// This method renames the file referenced by \p this as \p newName. The
00543       /// file referenced by \p this must exist. The file referenced by
00544       /// \p newName does not need to exist.
00545       /// @returns true on error, false otherwise
00546       /// @brief Rename one file as another.
00547       bool renamePathOnDisk(const Path& newName, std::string* ErrMsg);
00548 
00549       /// This method attempts to destroy the file or directory named by the
00550       /// last component of the Path. If the Path refers to a directory and the
00551       /// \p destroy_contents is false, an attempt will be made to remove just
00552       /// the directory (the final Path component). If \p destroy_contents is
00553       /// true, an attempt will be made to remove the entire contents of the
00554       /// directory, recursively. If the Path refers to a file, the
00555       /// \p destroy_contents parameter is ignored.
00556       /// @param destroy_contents Indicates whether the contents of a destroyed
00557       /// @param Err An optional string to receive an error message.
00558       /// directory should also be destroyed (recursively).
00559       /// @returns false if the file/directory was destroyed, true on error.
00560       /// @brief Removes the file or directory from the filesystem.
00561       bool eraseFromDisk(bool destroy_contents = false,
00562                          std::string *Err = 0) const;
00563 
00564 
00565       /// MapInFilePages - This is a low level system API to map in the file
00566       /// that is currently opened as FD into the current processes' address
00567       /// space for read only access.  This function may return null on failure
00568       /// or if the system cannot provide the following constraints:
00569       ///  1) The pages must be valid after the FD is closed, until
00570       ///     UnMapFilePages is called.
00571       ///  2) Any padding after the end of the file must be zero filled, if
00572       ///     present.
00573       ///  3) The pages must be contiguous.
00574       ///
00575       /// This API is not intended for general use, clients should use
00576       /// MemoryBuffer::getFile instead.
00577       static const char *MapInFilePages(int FD, uint64_t FileSize);
00578 
00579       /// UnMapFilePages - Free pages mapped into the current process by
00580       /// MapInFilePages.
00581       ///
00582       /// This API is not intended for general use, clients should use
00583       /// MemoryBuffer::getFile instead.
00584       static void UnMapFilePages(const char *Base, uint64_t FileSize);
00585 
00586     /// @}
00587     /// @name Data
00588     /// @{
00589     protected:
00590       // Our win32 implementation relies on this string being mutable.
00591       mutable std::string path;   ///< Storage for the path name.
00592 
00593 
00594     /// @}
00595   };
00596 
00597   /// This class is identical to Path class except it allows you to obtain the
00598   /// file status of the Path as well. The reason for the distinction is one of
00599   /// efficiency. First, the file status requires additional space and the space
00600   /// is incorporated directly into PathWithStatus without an additional malloc.
00601   /// Second, obtaining status information is an expensive operation on most
00602   /// operating systems so we want to be careful and explicity about where we
00603   /// allow this operation in LLVM.
00604   /// @brief Path with file status class.
00605   class PathWithStatus : public Path {
00606     /// @name Constructors
00607     /// @{
00608     public:
00609       /// @brief Default constructor
00610       PathWithStatus() : Path(), status(), fsIsValid(false) {}
00611 
00612       /// @brief Copy constructor
00613       PathWithStatus(const PathWithStatus &that)
00614         : Path(static_cast<const Path&>(that)), status(that.status),
00615            fsIsValid(that.fsIsValid) {}
00616 
00617       /// This constructor allows construction from a Path object
00618       /// @brief Path constructor
00619       PathWithStatus(const Path &other)
00620         : Path(other), status(), fsIsValid(false) {}
00621 
00622       /// This constructor will accept a std::string as a path. No checking is
00623       /// done on this path to determine if it is valid. To determine validity
00624       /// of the path, use the isValid method.
00625       /// @brief Construct a Path from a string.
00626       explicit PathWithStatus(
00627         const std::string& p ///< The path to assign.
00628       ) : Path(p), status(), fsIsValid(false) {}
00629 
00630       /// This constructor will accept a character range as a path.  No checking
00631       /// is done on this path to determine if it is valid.  To determine
00632       /// validity of the path, use the isValid method.
00633       /// @brief Construct a Path from a string.
00634       explicit PathWithStatus(
00635         const char *StrStart,  ///< Pointer to the first character of the path
00636         unsigned StrLen        ///< Length of the path.
00637       ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
00638 
00639       /// Makes a copy of \p that to \p this.
00640       /// @returns \p this
00641       /// @brief Assignment Operator
00642       PathWithStatus &operator=(const PathWithStatus &that) {
00643         static_cast<Path&>(*this) = static_cast<const Path&>(that);
00644         status = that.status;
00645         fsIsValid = that.fsIsValid;
00646         return *this;
00647       }
00648 
00649       /// Makes a copy of \p that to \p this.
00650       /// @returns \p this
00651       /// @brief Assignment Operator
00652       PathWithStatus &operator=(const Path &that) {
00653         static_cast<Path&>(*this) = static_cast<const Path&>(that);
00654         fsIsValid = false;
00655         return *this;
00656       }
00657 
00658     /// @}
00659     /// @name Methods
00660     /// @{
00661     public:
00662       /// This function returns status information about the file. The type of
00663       /// path (file or directory) is updated to reflect the actual contents
00664       /// of the file system.
00665       /// @returns 0 on failure, with Error explaining why (if non-zero)
00666       /// @returns a pointer to a FileStatus structure on success.
00667       /// @brief Get file status.
00668       const FileStatus *getFileStatus(
00669         bool forceUpdate = false, ///< Force an update from the file system
00670         std::string *Error = 0    ///< Optional place to return an error msg.
00671       ) const;
00672 
00673     /// @}
00674     /// @name Data
00675     /// @{
00676     private:
00677       mutable FileStatus status; ///< Status information.
00678       mutable bool fsIsValid;    ///< Whether we've obtained it or not
00679 
00680     /// @}
00681   };
00682 
00683   /// This enumeration delineates the kinds of files that LLVM knows about.
00684   enum LLVMFileType {
00685     Unknown_FileType = 0,              ///< Unrecognized file
00686     Bitcode_FileType,                  ///< Bitcode file
00687     Archive_FileType,                  ///< ar style archive file
00688     ELF_Relocatable_FileType,          ///< ELF Relocatable object file
00689     ELF_Executable_FileType,           ///< ELF Executable image
00690     ELF_SharedObject_FileType,         ///< ELF dynamically linked shared lib
00691     ELF_Core_FileType,                 ///< ELF core image
00692     Mach_O_Object_FileType,            ///< Mach-O Object file
00693     Mach_O_Executable_FileType,        ///< Mach-O Executable
00694     Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM
00695     Mach_O_Core_FileType,              ///< Mach-O Core File
00696     Mach_O_PreloadExectuable_FileType, ///< Mach-O Preloaded Executable
00697     Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib
00698     Mach_O_DynamicLinker_FileType,     ///< The Mach-O dynamic linker
00699     Mach_O_Bundle_FileType,            ///< Mach-O Bundle file
00700     Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub
00701     COFF_FileType                      ///< COFF object file or lib
00702   };
00703 
00704   /// This utility function allows any memory block to be examined in order
00705   /// to determine its file type.
00706   LLVMFileType IdentifyFileType(const char*magic, unsigned length);
00707 
00708   /// This function can be used to copy the file specified by Src to the
00709   /// file specified by Dest. If an error occurs, Dest is removed.
00710   /// @returns true if an error occurs, false otherwise
00711   /// @brief Copy one file to another.
00712   bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg);
00713 
00714   /// This is the OS-specific path separator: a colon on Unix or a semicolon
00715   /// on Windows.
00716   extern const char PathSeparator;
00717 }
00718 
00719 inline raw_ostream& operator<<(raw_ostream& strm, const sys::Path& aPath) {
00720   strm << aPath.toString();
00721   return strm;
00722 }
00723 
00724 inline raw_ostream& operator<<(raw_ostream& strm,
00725                                const sys::PathWithStatus& aPath) {
00726   strm << static_cast<const sys::Path&>(aPath);
00727   return strm;
00728 }
00729 
00730 std::ostream& operator<<(std::ostream& strm, const sys::Path& aPath);
00731 inline std::ostream& operator<<(std::ostream& strm,
00732                                 const sys::PathWithStatus& aPath) {
00733   strm << static_cast<const sys::Path&>(aPath);
00734   return strm;
00735 }
00736 
00737 }
00738 
00739 #endif