1 //===- llvm/System/Path.h - Path Operating System Concept -------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file declares the llvm::sys::Path class. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #ifndef LLVM_SYSTEM_PATH_H 15 #define LLVM_SYSTEM_PATH_H 16 17 #include "llvm/ADT/StringRef.h" 18 #include "llvm/System/TimeValue.h" 19 #include <set> 20 #include <string> 21 #include <vector> 22 23 namespace llvm { 24 namespace sys { 25 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 35 class FileStatus { 36 public: 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. 45 FileStatus()46 FileStatus() : fileSize(0), modTime(0,0), mode(0777), user(999), 47 group(999), uniqueID(0), isDir(false), isFile(false) { } 48 getTimestamp()49 TimeValue getTimestamp() const { return modTime; } getSize()50 uint64_t getSize() const { return fileSize; } getMode()51 uint32_t getMode() const { return mode; } getUser()52 uint32_t getUser() const { return user; } getGroup()53 uint32_t getGroup() const { return group; } getUniqueID()54 uint64_t getUniqueID() const { return uniqueID; } 55 }; 56 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. 83 /// @since 1.4 84 /// @brief An abstraction for operating system paths. 85 class Path { 86 /// @name Constructors 87 /// @{ 88 public: 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(); 96 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 104 /// directory. 105 static Path GetTemporaryDirectory(std::string* ErrMsg = 0); 106 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); 113 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 121 /// found. 122 static void GetBitcodeLibraryPaths(std::vector<sys::Path>& Paths); 123 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); 128 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(); 135 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(); 142 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(); 151 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(); 156 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(); 164 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); 169 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. Path()176 Path() : path() {} Path(const Path & that)177 Path(const Path &that) : path(that.path) {} 178 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); 185 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); 193 194 /// @} 195 /// @name Operators 196 /// @{ 197 public: 198 /// Makes a copy of \p that to \p this. 199 /// @returns \p this 200 /// @brief Assignment Operator 201 Path &operator=(const Path &that) { 202 path = that.path; 203 return *this; 204 } 205 206 /// Makes a copy of \p that to \p this. 207 /// @param that A StringRef denoting the path 208 /// @returns \p this 209 /// @brief Assignment Operator 210 Path &operator=(StringRef that); 211 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; 216 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); } 221 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; 229 230 /// @} 231 /// @name Path Accessors 232 /// @{ 233 public: 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; 242 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). isEmpty()250 bool isEmpty() const { return path.empty(); } 251 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; 259 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; 266 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; 270 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; 278 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. c_str()282 const char *c_str() const { return path.c_str(); } str()283 const std::string &str() const { return path; } 284 285 286 /// size - Return the length in bytes of this path name. size()287 size_t size() const { return path.size(); } 288 289 /// empty - Returns true if the path is empty. empty()290 unsigned empty() const { return path.empty(); } 291 292 /// @} 293 /// @name Disk Accessors 294 /// @{ 295 public: 296 /// This function determines if the path name is absolute, as opposed to 297 /// relative. 298 /// @brief Determine if the path is absolute. 299 bool isAbsolute() const; 300 301 /// This function determines if the path name is absolute, as opposed to 302 /// relative. 303 /// @brief Determine if the path is absolute. 304 static bool isAbsolute(const char *NameStart, unsigned NameLen); 305 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; 313 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, 318 /// false otherwise. 319 /// @brief Get the file's magic number. 320 bool getMagicNumber(std::string& Magic, unsigned len) const; 321 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 325 /// file. 326 /// @brief Determine if the path references an archive file. 327 bool isArchive() const; 328 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 332 /// bitcode files. 333 /// @brief Determine if the path references a bitcode file. 334 bool isBitcodeFile() const; 335 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 339 /// directory. 340 /// @returns true if the file starts with the magic number for a native 341 /// shared library. 342 /// @brief Determine if the path references a dynamic library. 343 bool isDynamicLibrary() const; 344 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 348 /// directory. 349 /// @brief Determines if the path is a file or directory in 350 /// the file system. 351 bool exists() const; 352 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; 358 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 362 /// or directory. 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; 367 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 371 /// directory. 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; 376 377 /// This function checks that what we're trying to work only on a regular file. 378 /// Check for things like /dev/null, any block special file, 379 /// or other things that aren't "regular" regular files. 380 /// @returns true if the file is S_ISREG. 381 /// @brief Determines if the file is a regular file 382 bool isRegularFile() const; 383 384 /// This function determines if the path name references an executable 385 /// file in the file system. This function checks for the existence and 386 /// executability (by the current program) of the file. 387 /// @returns true if the pathname references an executable file. 388 /// @brief Determines if the path is an executable file in the file 389 /// system. 390 bool canExecute() const; 391 392 /// This function builds a list of paths that are the names of the 393 /// files and directories in a directory. 394 /// @returns true if an error occurs, true otherwise 395 /// @brief Build a list of directory's contents. 396 bool getDirectoryContents( 397 std::set<Path> &paths, ///< The resulting list of file & directory names 398 std::string* ErrMsg ///< Optional place to return an error message. 399 ) const; 400 401 /// @} 402 /// @name Path Mutators 403 /// @{ 404 public: 405 /// The path name is cleared and becomes empty. This is an invalid 406 /// path name but is the *only* invalid path name. This is provided 407 /// so that path objects can be used to indicate the lack of a 408 /// valid path being found. 409 /// @brief Make the path empty. clear()410 void clear() { path.clear(); } 411 412 /// This method sets the Path object to \p unverified_path. This can fail 413 /// if the \p unverified_path does not pass the syntactic checks of the 414 /// isValid() method. If verification fails, the Path object remains 415 /// unchanged and false is returned. Otherwise true is returned and the 416 /// Path object takes on the path value of \p unverified_path 417 /// @returns true if the path was set, false otherwise. 418 /// @param unverified_path The path to be set in Path object. 419 /// @brief Set a full path from a StringRef 420 bool set(StringRef unverified_path); 421 422 /// One path component is removed from the Path. If only one component is 423 /// present in the path, the Path object becomes empty. If the Path object 424 /// is empty, no change is made. 425 /// @returns false if the path component could not be removed. 426 /// @brief Removes the last directory component of the Path. 427 bool eraseComponent(); 428 429 /// The \p component is added to the end of the Path if it is a legal 430 /// name for the operating system. A directory separator will be added if 431 /// needed. 432 /// @returns false if the path component could not be added. 433 /// @brief Appends one path component to the Path. 434 bool appendComponent(StringRef component); 435 436 /// A period and the \p suffix are appended to the end of the pathname. 437 /// The precondition for this function is that the Path reference a file 438 /// name (i.e. isFile() returns true). If the Path is not a file, no 439 /// action is taken and the function returns false. If the path would 440 /// become invalid for the host operating system, false is returned. 441 /// @returns false if the suffix could not be added, true if it was. 442 /// @brief Adds a period and the \p suffix to the end of the pathname. 443 bool appendSuffix(StringRef suffix); 444 445 /// The suffix of the filename is erased. The suffix begins with and 446 /// includes the last . character in the filename after the last directory 447 /// separator and extends until the end of the name. If no . character is 448 /// after the last directory separator, then the file name is left 449 /// unchanged (i.e. it was already without a suffix) but the function 450 /// returns false. 451 /// @returns false if there was no suffix to remove, true otherwise. 452 /// @brief Remove the suffix from a path name. 453 bool eraseSuffix(); 454 455 /// The current Path name is made unique in the file system. Upon return, 456 /// the Path will have been changed to make a unique file in the file 457 /// system or it will not have been changed if the current path name is 458 /// already unique. 459 /// @throws std::string if an unrecoverable error occurs. 460 /// @brief Make the current path name unique in the file system. 461 bool makeUnique( bool reuse_current /*= true*/, std::string* ErrMsg ); 462 463 /// The current Path name is made absolute by prepending the 464 /// current working directory if necessary. 465 void makeAbsolute(); 466 467 /// @} 468 /// @name Disk Mutators 469 /// @{ 470 public: 471 /// This method attempts to make the file referenced by the Path object 472 /// available for reading so that the canRead() method will return true. 473 /// @brief Make the file readable; 474 bool makeReadableOnDisk(std::string* ErrMsg = 0); 475 476 /// This method attempts to make the file referenced by the Path object 477 /// available for writing so that the canWrite() method will return true. 478 /// @brief Make the file writable; 479 bool makeWriteableOnDisk(std::string* ErrMsg = 0); 480 481 /// This method attempts to make the file referenced by the Path object 482 /// available for execution so that the canExecute() method will return 483 /// true. 484 /// @brief Make the file readable; 485 bool makeExecutableOnDisk(std::string* ErrMsg = 0); 486 487 /// This method allows the last modified time stamp and permission bits 488 /// to be set on the disk object referenced by the Path. 489 /// @throws std::string if an error occurs. 490 /// @returns true on error. 491 /// @brief Set the status information. 492 bool setStatusInfoOnDisk(const FileStatus &SI, 493 std::string *ErrStr = 0) const; 494 495 /// This method attempts to create a directory in the file system with the 496 /// same name as the Path object. The \p create_parents parameter controls 497 /// whether intermediate directories are created or not. if \p 498 /// create_parents is true, then an attempt will be made to create all 499 /// intermediate directories, as needed. If \p create_parents is false, 500 /// then only the final directory component of the Path name will be 501 /// created. The created directory will have no entries. 502 /// @returns true if the directory could not be created, false otherwise 503 /// @brief Create the directory this Path refers to. 504 bool createDirectoryOnDisk( 505 bool create_parents = false, ///< Determines whether non-existent 506 ///< directory components other than the last one (the "parents") 507 ///< are created or not. 508 std::string* ErrMsg = 0 ///< Optional place to put error messages. 509 ); 510 511 /// This method attempts to create a file in the file system with the same 512 /// name as the Path object. The intermediate directories must all exist 513 /// at the time this method is called. Use createDirectoriesOnDisk to 514 /// accomplish that. The created file will be empty upon return from this 515 /// function. 516 /// @returns true if the file could not be created, false otherwise. 517 /// @brief Create the file this Path refers to. 518 bool createFileOnDisk( 519 std::string* ErrMsg = 0 ///< Optional place to put error messages. 520 ); 521 522 /// This is like createFile except that it creates a temporary file. A 523 /// unique temporary file name is generated based on the contents of 524 /// \p this before the call. The new name is assigned to \p this and the 525 /// file is created. Note that this will both change the Path object 526 /// *and* create the corresponding file. This function will ensure that 527 /// the newly generated temporary file name is unique in the file system. 528 /// @returns true if the file couldn't be created, false otherwise. 529 /// @brief Create a unique temporary file 530 bool createTemporaryFileOnDisk( 531 bool reuse_current = false, ///< When set to true, this parameter 532 ///< indicates that if the current file name does not exist then 533 ///< it will be used without modification. 534 std::string* ErrMsg = 0 ///< Optional place to put error messages 535 ); 536 537 /// This method renames the file referenced by \p this as \p newName. The 538 /// file referenced by \p this must exist. The file referenced by 539 /// \p newName does not need to exist. 540 /// @returns true on error, false otherwise 541 /// @brief Rename one file as another. 542 bool renamePathOnDisk(const Path& newName, std::string* ErrMsg); 543 544 /// This method attempts to destroy the file or directory named by the 545 /// last component of the Path. If the Path refers to a directory and the 546 /// \p destroy_contents is false, an attempt will be made to remove just 547 /// the directory (the final Path component). If \p destroy_contents is 548 /// true, an attempt will be made to remove the entire contents of the 549 /// directory, recursively. If the Path refers to a file, the 550 /// \p destroy_contents parameter is ignored. 551 /// @param destroy_contents Indicates whether the contents of a destroyed 552 /// @param Err An optional string to receive an error message. 553 /// directory should also be destroyed (recursively). 554 /// @returns false if the file/directory was destroyed, true on error. 555 /// @brief Removes the file or directory from the filesystem. 556 bool eraseFromDisk(bool destroy_contents = false, 557 std::string *Err = 0) const; 558 559 560 /// MapInFilePages - This is a low level system API to map in the file 561 /// that is currently opened as FD into the current processes' address 562 /// space for read only access. This function may return null on failure 563 /// or if the system cannot provide the following constraints: 564 /// 1) The pages must be valid after the FD is closed, until 565 /// UnMapFilePages is called. 566 /// 2) Any padding after the end of the file must be zero filled, if 567 /// present. 568 /// 3) The pages must be contiguous. 569 /// 570 /// This API is not intended for general use, clients should use 571 /// MemoryBuffer::getFile instead. 572 static const char *MapInFilePages(int FD, uint64_t FileSize); 573 574 /// UnMapFilePages - Free pages mapped into the current process by 575 /// MapInFilePages. 576 /// 577 /// This API is not intended for general use, clients should use 578 /// MemoryBuffer::getFile instead. 579 static void UnMapFilePages(const char *Base, uint64_t FileSize); 580 581 /// @} 582 /// @name Data 583 /// @{ 584 protected: 585 // Our win32 implementation relies on this string being mutable. 586 mutable std::string path; ///< Storage for the path name. 587 588 589 /// @} 590 }; 591 592 /// This class is identical to Path class except it allows you to obtain the 593 /// file status of the Path as well. The reason for the distinction is one of 594 /// efficiency. First, the file status requires additional space and the space 595 /// is incorporated directly into PathWithStatus without an additional malloc. 596 /// Second, obtaining status information is an expensive operation on most 597 /// operating systems so we want to be careful and explicity about where we 598 /// allow this operation in LLVM. 599 /// @brief Path with file status class. 600 class PathWithStatus : public Path { 601 /// @name Constructors 602 /// @{ 603 public: 604 /// @brief Default constructor PathWithStatus()605 PathWithStatus() : Path(), status(), fsIsValid(false) {} 606 607 /// @brief Copy constructor PathWithStatus(const PathWithStatus & that)608 PathWithStatus(const PathWithStatus &that) 609 : Path(static_cast<const Path&>(that)), status(that.status), 610 fsIsValid(that.fsIsValid) {} 611 612 /// This constructor allows construction from a Path object 613 /// @brief Path constructor PathWithStatus(const Path & other)614 PathWithStatus(const Path &other) 615 : Path(other), status(), fsIsValid(false) {} 616 617 /// This constructor will accept a char* or std::string as a path. No 618 /// checking is done on this path to determine if it is valid. To 619 /// determine validity of the path, use the isValid method. 620 /// @brief Construct a Path from a string. PathWithStatus(StringRef p)621 explicit PathWithStatus( 622 StringRef p ///< The path to assign. 623 ) : Path(p), status(), fsIsValid(false) {} 624 625 /// This constructor will accept a character range as a path. No checking 626 /// is done on this path to determine if it is valid. To determine 627 /// validity of the path, use the isValid method. 628 /// @brief Construct a Path from a string. PathWithStatus(const char * StrStart,unsigned StrLen)629 explicit PathWithStatus( 630 const char *StrStart, ///< Pointer to the first character of the path 631 unsigned StrLen ///< Length of the path. 632 ) : Path(StrStart, StrLen), status(), fsIsValid(false) {} 633 634 /// Makes a copy of \p that to \p this. 635 /// @returns \p this 636 /// @brief Assignment Operator 637 PathWithStatus &operator=(const PathWithStatus &that) { 638 static_cast<Path&>(*this) = static_cast<const Path&>(that); 639 status = that.status; 640 fsIsValid = that.fsIsValid; 641 return *this; 642 } 643 644 /// Makes a copy of \p that to \p this. 645 /// @returns \p this 646 /// @brief Assignment Operator 647 PathWithStatus &operator=(const Path &that) { 648 static_cast<Path&>(*this) = static_cast<const Path&>(that); 649 fsIsValid = false; 650 return *this; 651 } 652 653 /// @} 654 /// @name Methods 655 /// @{ 656 public: 657 /// This function returns status information about the file. The type of 658 /// path (file or directory) is updated to reflect the actual contents 659 /// of the file system. 660 /// @returns 0 on failure, with Error explaining why (if non-zero) 661 /// @returns a pointer to a FileStatus structure on success. 662 /// @brief Get file status. 663 const FileStatus *getFileStatus( 664 bool forceUpdate = false, ///< Force an update from the file system 665 std::string *Error = 0 ///< Optional place to return an error msg. 666 ) const; 667 668 /// @} 669 /// @name Data 670 /// @{ 671 private: 672 mutable FileStatus status; ///< Status information. 673 mutable bool fsIsValid; ///< Whether we've obtained it or not 674 675 /// @} 676 }; 677 678 /// This enumeration delineates the kinds of files that LLVM knows about. 679 enum LLVMFileType { 680 Unknown_FileType = 0, ///< Unrecognized file 681 Bitcode_FileType, ///< Bitcode file 682 Archive_FileType, ///< ar style archive file 683 ELF_Relocatable_FileType, ///< ELF Relocatable object file 684 ELF_Executable_FileType, ///< ELF Executable image 685 ELF_SharedObject_FileType, ///< ELF dynamically linked shared lib 686 ELF_Core_FileType, ///< ELF core image 687 Mach_O_Object_FileType, ///< Mach-O Object file 688 Mach_O_Executable_FileType, ///< Mach-O Executable 689 Mach_O_FixedVirtualMemorySharedLib_FileType, ///< Mach-O Shared Lib, FVM 690 Mach_O_Core_FileType, ///< Mach-O Core File 691 Mach_O_PreloadExectuable_FileType, ///< Mach-O Preloaded Executable 692 Mach_O_DynamicallyLinkedSharedLib_FileType, ///< Mach-O dynlinked shared lib 693 Mach_O_DynamicLinker_FileType, ///< The Mach-O dynamic linker 694 Mach_O_Bundle_FileType, ///< Mach-O Bundle file 695 Mach_O_DynamicallyLinkedSharedLibStub_FileType, ///< Mach-O Shared lib stub 696 COFF_FileType ///< COFF object file or lib 697 }; 698 699 /// This utility function allows any memory block to be examined in order 700 /// to determine its file type. 701 LLVMFileType IdentifyFileType(const char*magic, unsigned length); 702 703 /// This function can be used to copy the file specified by Src to the 704 /// file specified by Dest. If an error occurs, Dest is removed. 705 /// @returns true if an error occurs, false otherwise 706 /// @brief Copy one file to another. 707 bool CopyFile(const Path& Dest, const Path& Src, std::string* ErrMsg); 708 709 /// This is the OS-specific path separator: a colon on Unix or a semicolon 710 /// on Windows. 711 extern const char PathSeparator; 712 } 713 714 } 715 716 #endif 717