include/llvm/Support/FileSystem.h

   1 //===- llvm/Support/FileSystem.h - File System OS 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::fs namespace. It is designed after
  11 // TR2/boost filesystem (v3), but modified to remove exception handling and the
  12 // path class.
  13 //
  14 // All functions return an error_code and their actual work via the last out
  15 // argument. The out argument is defined if and only if errc::success is
  16 // returned. A function may return any error code in the generic or system
  17 // category. However, they shall be equivalent to any error conditions listed
  18 // in each functions respective documentation if the condition applies. [ note:
  19 // this does not guarantee that error_code will be in the set of explicitly
  20 // listed codes, but it does guarantee that if any of the explicitly listed
  21 // errors occur, the correct error_code will be used ]. All functions may
  22 // return errc::not_enough_memory if there is not enough memory to complete the
  23 // operation.
  24 //
  25 //===----------------------------------------------------------------------===//
  26
  27 #ifndef LLVM_SUPPORT_FILE_SYSTEM_H
  28 #define LLVM_SUPPORT_FILE_SYSTEM_H
  29
  30 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  31 #include "llvm/ADT/SmallString.h"
  32 #include "llvm/ADT/Twine.h"
  33 #include "llvm/Support/DataTypes.h"
  34 #include "llvm/Support/ErrorHandling.h"
  35 #include "llvm/Support/system_error.h"
  36 #include <ctime>
  37 #include <iterator>
  38 #include <stack>
  39 #include <string>
  40 #include <vector>
  41
  42 #if HAVE_SYS_STAT_H
  43 #include <sys/stat.h>
  44 #endif
  45
  46 namespace llvm {
  47 namespace sys {
  48 namespace fs {
  49
  50 /// file_type - An "enum class" enumeration for the file system's view of the
  51 ///             type.
  52 struct file_type {
  53   enum _ {
  54     status_error,
  55     file_not_found,
  56     regular_file,
  57     directory_file,
  58     symlink_file,
  59     block_file,
  60     character_file,
  61     fifo_file,
  62     socket_file,
  63     type_unknown
  64   };
  65
  66   file_type(_ v) : v_(v) {}
  67   explicit file_type(int v) : v_(_(v)) {}
  68   operator int() const {return v_;}
  69
  70 private:
  71   int v_;
  72 };
  73
  74 /// copy_option - An "enum class" enumeration of copy semantics for copy
  75 ///               operations.
  76 struct copy_option {
  77   enum _ {
  78     fail_if_exists,
  79     overwrite_if_exists
  80   };
  81
  82   copy_option(_ v) : v_(v) {}
  83   explicit copy_option(int v) : v_(_(v)) {}
  84   operator int() const {return v_;}
  85
  86 private:
  87   int v_;
  88 };
  89
  90 /// space_info - Self explanatory.
  91 struct space_info {
  92   uint64_t capacity;
  93   uint64_t free;
  94   uint64_t available;
  95 };
  96
  97
  98 enum perms {
  99   no_perms     = 0,
 100   owner_read   = 0400,
 101   owner_write  = 0200,
 102   owner_exe    = 0100,
 103   owner_all    = owner_read | owner_write | owner_exe,
 104   group_read   =  040,
 105   group_write  =  020,
 106   group_exe    =  010,
 107   group_all    = group_read | group_write | group_exe,
 108   others_read  =   04,
 109   others_write =   02,
 110   others_exe   =   01,
 111   others_all   = others_read | others_write | others_exe,
 112   all_all      = owner_all | group_all | others_all,
 113   set_uid_on_exe  = 04000,
 114   set_gid_on_exe  = 02000,
 115   sticky_bit      = 01000,
 116   perms_mask      = all_all | set_uid_on_exe | set_gid_on_exe | sticky_bit,
 117   perms_not_known = 0xFFFF,
 118   add_perms       = 0x1000,
 119   remove_perms    = 0x2000,
 120   symlink_perms   = 0x4000
 121 };
 122
 123 // Helper functions so that you can use & and | to manipulate perms bits:
 124 inline perms operator|(perms l , perms r) {
 125   return static_cast<perms>(
 126              static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
 127 }
 128 inline perms operator&(perms l , perms r) {
 129   return static_cast<perms>(
 130              static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
 131 }
 132 inline perms &operator|=(perms &l, perms r) {
 133   l = l | r;
 134   return l;
 135 }
 136 inline perms &operator&=(perms &l, perms r) {
 137   l = l & r;
 138   return l;
 139 }
 140 inline perms operator~(perms x) {
 141   return static_cast<perms>(~static_cast<unsigned short>(x));
 142 }
 143
 144
 145
 146 /// file_status - Represents the result of a call to stat and friends. It has
 147 ///               a platform specific member to store the result.
 148 class file_status
 149 {
 150   #if defined(LLVM_ON_UNIX)
 151   dev_t fs_st_dev;
 152   ino_t fs_st_ino;
 153   #elif defined (LLVM_ON_WIN32)
 154   uint32_t LastWriteTimeHigh;
 155   uint32_t LastWriteTimeLow;
 156   uint32_t VolumeSerialNumber;
 157   uint32_t FileSizeHigh;
 158   uint32_t FileSizeLow;
 159   uint32_t FileIndexHigh;
 160   uint32_t FileIndexLow;
 161   #endif
 162   friend bool equivalent(file_status A, file_status B);
 163   friend error_code status(const Twine &path, file_status &result);
 164   file_type Type;
 165   perms Perms;
 166 public:
 167   explicit file_status(file_type v=file_type::status_error,
 168                       perms prms=perms_not_known)
 169     : Type(v), Perms(prms) {}
 170
 171   // getters
 172   file_type type() const { return Type; }
 173   perms permissions() const { return Perms; }
 174
 175   // setters
 176   void type(file_type v) { Type = v; }
 177   void permissions(perms p) { Perms = p; }
 178 };
 179
 180 /// file_magic - An "enum class" enumeration of file types based on magic (the first
 181 ///         N bytes of the file).
 182 struct file_magic {
 183   enum _ {
 184     unknown = 0,              ///< Unrecognized file
 185     bitcode,                  ///< Bitcode file
 186     archive,                  ///< ar style archive file
 187     elf_relocatable,          ///< ELF Relocatable object file
 188     elf_executable,           ///< ELF Executable image
 189     elf_shared_object,        ///< ELF dynamically linked shared lib
 190     elf_core,                 ///< ELF core image
 191     macho_object,             ///< Mach-O Object file
 192     macho_executable,         ///< Mach-O Executable
 193     macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
 194     macho_core,               ///< Mach-O Core File
 195     macho_preload_executabl,  ///< Mach-O Preloaded Executable
 196     macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
 197     macho_dynamic_linker,     ///< The Mach-O dynamic linker
 198     macho_bundle,             ///< Mach-O Bundle file
 199     macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
 200     macho_dsym_companion,     ///< Mach-O dSYM companion file
 201     coff_object,              ///< COFF object file
 202     pecoff_executable         ///< PECOFF executable file
 203   };
 204
 205   bool is_object() const {
 206     return v_ == unknown ? false : true;
 207   }
 208
 209   file_magic() : v_(unknown) {}
 210   file_magic(_ v) : v_(v) {}
 211   explicit file_magic(int v) : v_(_(v)) {}
 212   operator int() const {return v_;}
 213
 214 private:
 215   int v_;
 216 };
 217
 218 /// @}
 219 /// @name Physical Operators
 220 /// @{
 221
 222 /// @brief Make \a path an absolute path.
 223 ///
 224 /// Makes \a path absolute using the current directory if it is not already. An
 225 /// empty \a path will result in the current directory.
 226 ///
 227 /// /absolute/path   => /absolute/path
 228 /// relative/../path => <current-directory>/relative/../path
 229 ///
 230 /// @param path A path that is modified to be an absolute path.
 231 /// @returns errc::success if \a path has been made absolute, otherwise a
 232 ///          platform specific error_code.
 233 error_code make_absolute(SmallVectorImpl<char> &path);
 234
 235 /// @brief Copy the file at \a from to the path \a to.
 236 ///
 237 /// @param from The path to copy the file from.
 238 /// @param to The path to copy the file to.
 239 /// @param copt Behavior if \a to already exists.
 240 /// @returns errc::success if the file has been successfully copied.
 241 ///          errc::file_exists if \a to already exists and \a copt ==
 242 ///          copy_option::fail_if_exists. Otherwise a platform specific
 243 ///          error_code.
 244 error_code copy_file(const Twine &from, const Twine &to,
 245                      copy_option copt = copy_option::fail_if_exists);
 246
 247 /// @brief Create all the non-existent directories in path.
 248 ///
 249 /// @param path Directories to create.
 250 /// @param existed Set to true if \a path already existed, false otherwise.
 251 /// @returns errc::success if is_directory(path) and existed have been set,
 252 ///          otherwise a platform specific error_code.
 253 error_code create_directories(const Twine &path, bool &existed);
 254
 255 /// @brief Create the directory in path.
 256 ///
 257 /// @param path Directory to create.
 258 /// @param existed Set to true if \a path already existed, false otherwise.
 259 /// @returns errc::success if is_directory(path) and existed have been set,
 260 ///          otherwise a platform specific error_code.
 261 error_code create_directory(const Twine &path, bool &existed);
 262
 263 /// @brief Create a hard link from \a from to \a to.
 264 ///
 265 /// @param to The path to hard link to.
 266 /// @param from The path to hard link from. This is created.
 267 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
 268 ///          , otherwise a platform specific error_code.
 269 error_code create_hard_link(const Twine &to, const Twine &from);
 270
 271 /// @brief Create a symbolic link from \a from to \a to.
 272 ///
 273 /// @param to The path to symbolically link to.
 274 /// @param from The path to symbolically link from. This is created.
 275 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
 276 ///          otherwise a platform specific error_code.
 277 error_code create_symlink(const Twine &to, const Twine &from);
 278
 279 /// @brief Get the current path.
 280 ///
 281 /// @param result Holds the current path on return.
 282 /// @results errc::success if the current path has been stored in result,
 283 ///          otherwise a platform specific error_code.
 284 error_code current_path(SmallVectorImpl<char> &result);
 285
 286 /// @brief Remove path. Equivalent to POSIX remove().
 287 ///
 288 /// @param path Input path.
 289 /// @param existed Set to true if \a path existed, false if it did not.
 290 ///                undefined otherwise.
 291 /// @results errc::success if path has been removed and existed has been
 292 ///          successfully set, otherwise a platform specific error_code.
 293 error_code remove(const Twine &path, bool &existed);
 294
 295 /// @brief Recursively remove all files below \a path, then \a path. Files are
 296 ///        removed as if by POSIX remove().
 297 ///
 298 /// @param path Input path.
 299 /// @param num_removed Number of files removed.
 300 /// @results errc::success if path has been removed and num_removed has been
 301 ///          successfully set, otherwise a platform specific error_code.
 302 error_code remove_all(const Twine &path, uint32_t &num_removed);
 303
 304 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
 305 ///
 306 /// @param from The path to rename from.
 307 /// @param to The path to rename to. This is created.
 308 error_code rename(const Twine &from, const Twine &to);
 309
 310 /// @brief Resize path to size. File is resized as if by POSIX truncate().
 311 ///
 312 /// @param path Input path.
 313 /// @param size Size to resize to.
 314 /// @returns errc::success if \a path has been resized to \a size, otherwise a
 315 ///          platform specific error_code.
 316 error_code resize_file(const Twine &path, uint64_t size);
 317
 318 /// @}
 319 /// @name Physical Observers
 320 /// @{
 321
 322 /// @brief Does file exist?
 323 ///
 324 /// @param status A file_status previously returned from stat.
 325 /// @results True if the file represented by status exists, false if it does
 326 ///          not.
 327 bool exists(file_status status);
 328
 329 /// @brief Does file exist?
 330 ///
 331 /// @param path Input path.
 332 /// @param result Set to true if the file represented by status exists, false if
 333 ///               it does not. Undefined otherwise.
 334 /// @results errc::success if result has been successfully set, otherwise a
 335 ///          platform specific error_code.
 336 error_code exists(const Twine &path, bool &result);
 337
 338 /// @brief Simpler version of exists for clients that don't need to
 339 ///        differentiate between an error and false.
 340 inline bool exists(const Twine &path) {
 341   bool result;
 342   return !exists(path, result) && result;
 343 }
 344
 345 /// @brief Do file_status's represent the same thing?
 346 ///
 347 /// @param A Input file_status.
 348 /// @param B Input file_status.
 349 ///
 350 /// assert(status_known(A) || status_known(B));
 351 ///
 352 /// @results True if A and B both represent the same file system entity, false
 353 ///          otherwise.
 354 bool equivalent(file_status A, file_status B);
 355
 356 /// @brief Do paths represent the same thing?
 357 ///
 358 /// assert(status_known(A) || status_known(B));
 359 ///
 360 /// @param A Input path A.
 361 /// @param B Input path B.
 362 /// @param result Set to true if stat(A) and stat(B) have the same device and
 363 ///               inode (or equivalent).
 364 /// @results errc::success if result has been successfully set, otherwise a
 365 ///          platform specific error_code.
 366 error_code equivalent(const Twine &A, const Twine &B, bool &result);
 367
 368 /// @brief Simpler version of equivalent for clients that don't need to
 369 ///        differentiate between an error and false.
 370 inline bool equivalent(const Twine &A, const Twine &B) {
 371   bool result;
 372   return !equivalent(A, B, result) && result;
 373 }
 374
 375 /// @brief Get file size.
 376 ///
 377 /// @param path Input path.
 378 /// @param result Set to the size of the file in \a path.
 379 /// @returns errc::success if result has been successfully set, otherwise a
 380 ///          platform specific error_code.
 381 error_code file_size(const Twine &path, uint64_t &result);
 382
 383 /// @brief Does status represent a directory?
 384 ///
 385 /// @param status A file_status previously returned from status.
 386 /// @results status.type() == file_type::directory_file.
 387 bool is_directory(file_status status);
 388
 389 /// @brief Is path a directory?
 390 ///
 391 /// @param path Input path.
 392 /// @param result Set to true if \a path is a directory, false if it is not.
 393 ///               Undefined otherwise.
 394 /// @results errc::success if result has been successfully set, otherwise a
 395 ///          platform specific error_code.
 396 error_code is_directory(const Twine &path, bool &result);
 397
 398 /// @brief Does status represent a regular file?
 399 ///
 400 /// @param status A file_status previously returned from status.
 401 /// @results status_known(status) && status.type() == file_type::regular_file.
 402 bool is_regular_file(file_status status);
 403
 404 /// @brief Is path a regular file?
 405 ///
 406 /// @param path Input path.
 407 /// @param result Set to true if \a path is a regular file, false if it is not.
 408 ///               Undefined otherwise.
 409 /// @results errc::success if result has been successfully set, otherwise a
 410 ///          platform specific error_code.
 411 error_code is_regular_file(const Twine &path, bool &result);
 412
 413 /// @brief Does this status represent something that exists but is not a
 414 ///        directory, regular file, or symlink?
 415 ///
 416 /// @param status A file_status previously returned from status.
 417 /// @results exists(s) && !is_regular_file(s) && !is_directory(s) &&
 418 ///          !is_symlink(s)
 419 bool is_other(file_status status);
 420
 421 /// @brief Is path something that exists but is not a directory,
 422 ///        regular file, or symlink?
 423 ///
 424 /// @param path Input path.
 425 /// @param result Set to true if \a path exists, but is not a directory, regular
 426 ///               file, or a symlink, false if it does not. Undefined otherwise.
 427 /// @results errc::success if result has been successfully set, otherwise a
 428 ///          platform specific error_code.
 429 error_code is_other(const Twine &path, bool &result);
 430
 431 /// @brief Does status represent a symlink?
 432 ///
 433 /// @param status A file_status previously returned from stat.
 434 /// @param result status.type() == symlink_file.
 435 bool is_symlink(file_status status);
 436
 437 /// @brief Is path a symlink?
 438 ///
 439 /// @param path Input path.
 440 /// @param result Set to true if \a path is a symlink, false if it is not.
 441 ///               Undefined otherwise.
 442 /// @results errc::success if result has been successfully set, otherwise a
 443 ///          platform specific error_code.
 444 error_code is_symlink(const Twine &path, bool &result);
 445
 446 /// @brief Get file status as if by POSIX stat().
 447 ///
 448 /// @param path Input path.
 449 /// @param result Set to the file status.
 450 /// @results errc::success if result has been successfully set, otherwise a
 451 ///          platform specific error_code.
 452 error_code status(const Twine &path, file_status &result);
 453
 454 /// @brief Modifies permission bits on a file
 455 ///
 456 /// @param path Input path.
 457 /// @results errc::success if permissions have been changed, otherwise a
 458 ///          platform specific error_code.
 459 error_code permissions(const Twine &path, perms prms);
 460
 461 /// @brief Is status available?
 462 ///
 463 /// @param path Input path.
 464 /// @results True if status() != status_error.
 465 bool status_known(file_status s);
 466
 467 /// @brief Is status available?
 468 ///
 469 /// @param path Input path.
 470 /// @param result Set to true if status() != status_error.
 471 /// @results errc::success if result has been successfully set, otherwise a
 472 ///          platform specific error_code.
 473 error_code status_known(const Twine &path, bool &result);
 474
 475 /// @brief Generate a unique path and open it as a file.
 476 ///
 477 /// Generates a unique path suitable for a temporary file and then opens it as a
 478 /// file. The name is based on \a model with '%' replaced by a random char in
 479 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
 480 /// directory will be prepended.
 481 ///
 482 /// This is an atomic operation. Either the file is created and opened, or the
 483 /// file system is left untouched.
 484 ///
 485 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
 486 ///
 487 /// @param model Name to base unique path off of.
 488 /// @param result_fs Set to the opened file's file descriptor.
 489 /// @param result_path Set to the opened file's absolute path.
 490 /// @param makeAbsolute If true and @model is not an absolute path, a temp
 491 ///        directory will be prepended.
 492 /// @results errc::success if result_{fd,path} have been successfully set,
 493 ///          otherwise a platform specific error_code.
 494 error_code unique_file(const Twine &model, int &result_fd,
 495                        SmallVectorImpl<char> &result_path,
 496                        bool makeAbsolute = true, unsigned mode = 0600);
 497
 498 /// @brief Canonicalize path.
 499 ///
 500 /// Sets result to the file system's idea of what path is. The result is always
 501 /// absolute and has the same capitalization as the file system.
 502 ///
 503 /// @param path Input path.
 504 /// @param result Set to the canonicalized version of \a path.
 505 /// @results errc::success if result has been successfully set, otherwise a
 506 ///          platform specific error_code.
 507 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
 508
 509 /// @brief Are \a path's first bytes \a magic?
 510 ///
 511 /// @param path Input path.
 512 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
 513 /// @results errc::success if result has been successfully set, otherwise a
 514 ///          platform specific error_code.
 515 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
 516
 517 /// @brief Get \a path's first \a len bytes.
 518 ///
 519 /// @param path Input path.
 520 /// @param len Number of magic bytes to get.
 521 /// @param result Set to the first \a len bytes in the file pointed to by
 522 ///               \a path. Or the entire file if file_size(path) < len, in which
 523 ///               case result.size() returns the size of the file.
 524 /// @results errc::success if result has been successfully set,
 525 ///          errc::value_too_large if len is larger then the file pointed to by
 526 ///          \a path, otherwise a platform specific error_code.
 527 error_code get_magic(const Twine &path, uint32_t len,
 528                      SmallVectorImpl<char> &result);
 529
 530 /// @brief Identify the type of a binary file based on how magical it is.
 531 file_magic identify_magic(StringRef magic);
 532
 533 /// @brief Get and identify \a path's type based on its content.
 534 ///
 535 /// @param path Input path.
 536 /// @param result Set to the type of file, or LLVMFileType::Unknown_FileType.
 537 /// @results errc::success if result has been successfully set, otherwise a
 538 ///          platform specific error_code.
 539 error_code identify_magic(const Twine &path, file_magic &result);
 540
 541 /// @brief Get library paths the system linker uses.
 542 ///
 543 /// @param result Set to the list of system library paths.
 544 /// @results errc::success if result has been successfully set, otherwise a
 545 ///          platform specific error_code.
 546 error_code GetSystemLibraryPaths(SmallVectorImpl<std::string> &result);
 547
 548 /// @brief Get bitcode library paths the system linker uses
 549 ///        + LLVM_LIB_SEARCH_PATH + LLVM_LIBDIR.
 550 ///
 551 /// @param result Set to the list of bitcode library paths.
 552 /// @results errc::success if result has been successfully set, otherwise a
 553 ///          platform specific error_code.
 554 error_code GetBitcodeLibraryPaths(SmallVectorImpl<std::string> &result);
 555
 556 /// @brief Find a library.
 557 ///
 558 /// Find the path to a library using its short name. Use the system
 559 /// dependent library paths to locate the library.
 560 ///
 561 /// c => /usr/lib/libc.so
 562 ///
 563 /// @param short_name Library name one would give to the system linker.
 564 /// @param result Set to the absolute path \a short_name represents.
 565 /// @results errc::success if result has been successfully set, otherwise a
 566 ///          platform specific error_code.
 567 error_code FindLibrary(const Twine &short_name, SmallVectorImpl<char> &result);
 568
 569 /// @brief Get absolute path of main executable.
 570 ///
 571 /// @param argv0 The program name as it was spelled on the command line.
 572 /// @param MainAddr Address of some symbol in the executable (not in a library).
 573 /// @param result Set to the absolute path of the current executable.
 574 /// @results errc::success if result has been successfully set, otherwise a
 575 ///          platform specific error_code.
 576 error_code GetMainExecutable(const char *argv0, void *MainAddr,
 577                              SmallVectorImpl<char> &result);
 578
 579
 580 /// @brief Memory maps the contents of a file
 581 ///
 582 /// @param path Path to file to map.
 583 /// @param file_offset Byte offset in file where mapping should begin.
 584 /// @param size_t Byte length of range of the file to map.
 585 /// @param map_writable If true, the file will be mapped in r/w such
 586 ///        that changes to the the mapped buffer will be flushed back
 587 ///        to the file.  If false, the file will be mapped read-only
 588 ///        and the buffer will be read-only.
 589 /// @param result Set to the start address of the mapped buffer.
 590 /// @results errc::success if result has been successfully set, otherwise a
 591 ///          platform specific error_code.
 592 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
 593                           bool map_writable, void *&result);
 594
 595
 596 /// @brief Memory unmaps the contents of a file
 597 ///
 598 /// @param base Pointer to the start of the buffer.
 599 /// @param size Byte length of the range to unmmap.
 600 /// @results errc::success if result has been successfully set, otherwise a
 601 ///          platform specific error_code.
 602 error_code unmap_file_pages(void *base, size_t size);
 603
 604
 605
 606 /// @}
 607 /// @name Iterators
 608 /// @{
 609
 610 /// directory_entry - A single entry in a directory. Caches the status either
 611 /// from the result of the iteration syscall, or the first time status is
 612 /// called.
 613 class directory_entry {
 614   std::string Path;
 615   mutable file_status Status;
 616
 617 public:
 618   explicit directory_entry(const Twine &path, file_status st = file_status())
 619     : Path(path.str())
 620     , Status(st) {}
 621
 622   directory_entry() {}
 623
 624   void assign(const Twine &path, file_status st = file_status()) {
 625     Path = path.str();
 626     Status = st;
 627   }
 628
 629   void replace_filename(const Twine &filename, file_status st = file_status());
 630
 631   const std::string &path() const { return Path; }
 632   error_code status(file_status &result) const;
 633
 634   bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
 635   bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
 636   bool operator< (const directory_entry& rhs) const;
 637   bool operator<=(const directory_entry& rhs) const;
 638   bool operator> (const directory_entry& rhs) const;
 639   bool operator>=(const directory_entry& rhs) const;
 640 };
 641
 642 namespace detail {
 643   struct DirIterState;
 644
 645   error_code directory_iterator_construct(DirIterState&, StringRef);
 646   error_code directory_iterator_increment(DirIterState&);
 647   error_code directory_iterator_destruct(DirIterState&);
 648
 649   /// DirIterState - Keeps state for the directory_iterator. It is reference
 650   /// counted in order to preserve InputIterator semantics on copy.
 651   struct DirIterState : public RefCountedBase<DirIterState> {
 652     DirIterState()
 653       : IterationHandle(0) {}
 654
 655     ~DirIterState() {
 656       directory_iterator_destruct(*this);
 657     }
 658
 659     intptr_t IterationHandle;
 660     directory_entry CurrentEntry;
 661   };
 662 }
 663
 664 /// directory_iterator - Iterates through the entries in path. There is no
 665 /// operator++ because we need an error_code. If it's really needed we can make
 666 /// it call report_fatal_error on error.
 667 class directory_iterator {
 668   IntrusiveRefCntPtr<detail::DirIterState> State;
 669
 670 public:
 671   explicit directory_iterator(const Twine &path, error_code &ec) {
 672     State = new detail::DirIterState;
 673     SmallString<128> path_storage;
 674     ec = detail::directory_iterator_construct(*State,
 675             path.toStringRef(path_storage));
 676   }
 677
 678   explicit directory_iterator(const directory_entry &de, error_code &ec) {
 679     State = new detail::DirIterState;
 680     ec = detail::directory_iterator_construct(*State, de.path());
 681   }
 682
 683   /// Construct end iterator.
 684   directory_iterator() : State(new detail::DirIterState) {}
 685
 686   // No operator++ because we need error_code.
 687   directory_iterator &increment(error_code &ec) {
 688     ec = directory_iterator_increment(*State);
 689     return *this;
 690   }
 691
 692   const directory_entry &operator*() const { return State->CurrentEntry; }
 693   const directory_entry *operator->() const { return &State->CurrentEntry; }
 694
 695   bool operator==(const directory_iterator &RHS) const {
 696     return State->CurrentEntry == RHS.State->CurrentEntry;
 697   }
 698
 699   bool operator!=(const directory_iterator &RHS) const {
 700     return !(*this == RHS);
 701   }
 702   // Other members as required by
 703   // C++ Std, 24.1.1 Input iterators [input.iterators]
 704 };
 705
 706 namespace detail {
 707   /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
 708   /// reference counted in order to preserve InputIterator semantics on copy.
 709   struct RecDirIterState : public RefCountedBase<RecDirIterState> {
 710     RecDirIterState()
 711       : Level(0)
 712       , HasNoPushRequest(false) {}
 713
 714     std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
 715     uint16_t Level;
 716     bool HasNoPushRequest;
 717   };
 718 }
 719
 720 /// recursive_directory_iterator - Same as directory_iterator except for it
 721 /// recurses down into child directories.
 722 class recursive_directory_iterator {
 723   IntrusiveRefCntPtr<detail::RecDirIterState> State;
 724
 725 public:
 726   recursive_directory_iterator() {}
 727   explicit recursive_directory_iterator(const Twine &path, error_code &ec)
 728     : State(new detail::RecDirIterState) {
 729     State->Stack.push(directory_iterator(path, ec));
 730     if (State->Stack.top() == directory_iterator())
 731       State.reset();
 732   }
 733   // No operator++ because we need error_code.
 734   recursive_directory_iterator &increment(error_code &ec) {
 735     static const directory_iterator end_itr;
 736
 737     if (State->HasNoPushRequest)
 738       State->HasNoPushRequest = false;
 739     else {
 740       file_status st;
 741       if ((ec = State->Stack.top()->status(st))) return *this;
 742       if (is_directory(st)) {
 743         State->Stack.push(directory_iterator(*State->Stack.top(), ec));
 744         if (ec) return *this;
 745         if (State->Stack.top() != end_itr) {
 746           ++State->Level;
 747           return *this;
 748         }
 749         State->Stack.pop();
 750       }
 751     }
 752
 753     while (!State->Stack.empty()
 754            && State->Stack.top().increment(ec) == end_itr) {
 755       State->Stack.pop();
 756       --State->Level;
 757     }
 758
 759     // Check if we are done. If so, create an end iterator.
 760     if (State->Stack.empty())
 761       State.reset();
 762
 763     return *this;
 764   }
 765
 766   const directory_entry &operator*() const { return *State->Stack.top(); }
 767   const directory_entry *operator->() const { return &*State->Stack.top(); }
 768
 769   // observers
 770   /// Gets the current level. Starting path is at level 0.
 771   int level() const { return State->Level; }
 772
 773   /// Returns true if no_push has been called for this directory_entry.
 774   bool no_push_request() const { return State->HasNoPushRequest; }
 775
 776   // modifiers
 777   /// Goes up one level if Level > 0.
 778   void pop() {
 779     assert(State && "Cannot pop and end itertor!");
 780     assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
 781
 782     static const directory_iterator end_itr;
 783     error_code ec;
 784     do {
 785       if (ec)
 786         report_fatal_error("Error incrementing directory iterator.");
 787       State->Stack.pop();
 788       --State->Level;
 789     } while (!State->Stack.empty()
 790              && State->Stack.top().increment(ec) == end_itr);
 791
 792     // Check if we are done. If so, create an end iterator.
 793     if (State->Stack.empty())
 794       State.reset();
 795   }
 796
 797   /// Does not go down into the current directory_entry.
 798   void no_push() { State->HasNoPushRequest = true; }
 799
 800   bool operator==(const recursive_directory_iterator &RHS) const {
 801     return State == RHS.State;
 802   }
 803
 804   bool operator!=(const recursive_directory_iterator &RHS) const {
 805     return !(*this == RHS);
 806   }
 807   // Other members as required by
 808   // C++ Std, 24.1.1 Input iterators [input.iterators]
 809 };
 810
 811 /// @}
 812
 813 } // end namespace fs
 814 } // end namespace sys
 815 } // end namespace llvm
 816
 817 #endif