1 //===- llvm/Support/FileSystem.h - File System OS Concept -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the llvm::sys::fs namespace. It is designed after
11 // TR2/boost filesystem (v3), but modified to remove exception handling and the
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
25 //===----------------------------------------------------------------------===//
27 #ifndef LLVM_SUPPORT_FILESYSTEM_H
28 #define LLVM_SUPPORT_FILESYSTEM_H
30 #include "llvm/ADT/IntrusiveRefCntPtr.h"
31 #include "llvm/ADT/OwningPtr.h"
32 #include "llvm/ADT/SmallString.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/TimeValue.h"
37 #include "llvm/Support/system_error.h"
44 #ifdef HAVE_SYS_STAT_H
52 /// file_type - An "enum class" enumeration for the file system's view of the
68 file_type(_ v) : v_(v) {}
69 explicit file_type(int v) : v_(_(v)) {}
70 operator int() const {return v_;}
76 /// copy_option - An "enum class" enumeration of copy semantics for copy
84 copy_option(_ v) : v_(v) {}
85 explicit copy_option(int v) : v_(_(v)) {}
86 operator int() const {return v_;}
92 /// space_info - Self explanatory.
104 owner_all = owner_read | owner_write | owner_exe,
108 group_all = group_read | group_write | group_exe,
112 others_all = others_read | others_write | others_exe,
113 all_read = owner_read | group_read | others_read,
114 all_write = owner_write | group_write | others_write,
115 all_exe = owner_exe | group_exe | others_exe,
116 all_all = owner_all | group_all | others_all,
117 set_uid_on_exe = 04000,
118 set_gid_on_exe = 02000,
120 perms_not_known = 0xFFFF
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));
128 inline perms operator&(perms l , perms r) {
129 return static_cast<perms>(
130 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
132 inline perms &operator|=(perms &l, perms r) {
136 inline perms &operator&=(perms &l, perms r) {
140 inline perms operator~(perms x) {
141 return static_cast<perms>(~static_cast<unsigned short>(x));
146 /// file_status - Represents the result of a call to stat and friends. It has
147 /// a platform specific member to store the result.
150 #if defined(LLVM_ON_UNIX)
156 #elif defined (LLVM_ON_WIN32)
157 uint32_t LastWriteTimeHigh;
158 uint32_t LastWriteTimeLow;
159 uint32_t VolumeSerialNumber;
160 uint32_t FileSizeHigh;
161 uint32_t FileSizeLow;
162 uint32_t FileIndexHigh;
163 uint32_t FileIndexLow;
165 friend bool equivalent(file_status A, file_status B);
166 friend error_code status(const Twine &path, file_status &result);
167 friend error_code getUniqueID(const Twine Path, uint64_t &Result);
171 explicit file_status(file_type v=file_type::status_error,
172 perms prms=perms_not_known)
173 : Type(v), Perms(prms) {}
176 file_type type() const { return Type; }
177 perms permissions() const { return Perms; }
178 TimeValue getLastModificationTime() const;
180 #if defined(LLVM_ON_UNIX)
181 uint32_t getUser() const { return fs_st_uid; }
182 uint32_t getGroup() const { return fs_st_gid; }
183 #elif defined (LLVM_ON_WIN32)
184 uint32_t getUser() const {
185 return 9999; // Not applicable to Windows, so...
187 uint32_t getGroup() const {
188 return 9999; // Not applicable to Windows, so...
193 void type(file_type v) { Type = v; }
194 void permissions(perms p) { Perms = p; }
197 /// file_magic - An "enum class" enumeration of file types based on magic (the first
198 /// N bytes of the file).
201 unknown = 0, ///< Unrecognized file
202 bitcode, ///< Bitcode file
203 archive, ///< ar style archive file
204 elf_relocatable, ///< ELF Relocatable object file
205 elf_executable, ///< ELF Executable image
206 elf_shared_object, ///< ELF dynamically linked shared lib
207 elf_core, ///< ELF core image
208 macho_object, ///< Mach-O Object file
209 macho_executable, ///< Mach-O Executable
210 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
211 macho_core, ///< Mach-O Core File
212 macho_preload_executable, ///< Mach-O Preloaded Executable
213 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
214 macho_dynamic_linker, ///< The Mach-O dynamic linker
215 macho_bundle, ///< Mach-O Bundle file
216 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
217 macho_dsym_companion, ///< Mach-O dSYM companion file
218 macho_universal_binary, ///< Mach-O universal binary
219 coff_object, ///< COFF object file
220 pecoff_executable ///< PECOFF executable file
223 bool is_object() const {
224 return V == unknown ? false : true;
227 file_magic() : V(unknown) {}
228 file_magic(Impl V) : V(V) {}
229 operator Impl() const { return V; }
236 /// @name Physical Operators
239 /// @brief Make \a path an absolute path.
241 /// Makes \a path absolute using the current directory if it is not already. An
242 /// empty \a path will result in the current directory.
244 /// /absolute/path => /absolute/path
245 /// relative/../path => <current-directory>/relative/../path
247 /// @param path A path that is modified to be an absolute path.
248 /// @returns errc::success if \a path has been made absolute, otherwise a
249 /// platform specific error_code.
250 error_code make_absolute(SmallVectorImpl<char> &path);
252 /// @brief Copy the file at \a from to the path \a to.
254 /// @param from The path to copy the file from.
255 /// @param to The path to copy the file to.
256 /// @param copt Behavior if \a to already exists.
257 /// @returns errc::success if the file has been successfully copied.
258 /// errc::file_exists if \a to already exists and \a copt ==
259 /// copy_option::fail_if_exists. Otherwise a platform specific
261 error_code copy_file(const Twine &from, const Twine &to,
262 copy_option copt = copy_option::fail_if_exists);
264 /// @brief Create all the non-existent directories in path.
266 /// @param path Directories to create.
267 /// @param existed Set to true if \a path already existed, false otherwise.
268 /// @returns errc::success if is_directory(path) and existed have been set,
269 /// otherwise a platform specific error_code.
270 error_code create_directories(const Twine &path, bool &existed);
272 /// @brief Convenience function for clients that don't need to know if the
273 /// directory existed or not.
274 inline error_code create_directories(const Twine &Path) {
276 return create_directories(Path, Existed);
279 /// @brief Create the directory in path.
281 /// @param path Directory to create.
282 /// @param existed Set to true if \a path already existed, false otherwise.
283 /// @returns errc::success if is_directory(path) and existed have been set,
284 /// otherwise a platform specific error_code.
285 error_code create_directory(const Twine &path, bool &existed);
287 /// @brief Convenience function for clients that don't need to know if the
288 /// directory existed or not.
289 inline error_code create_directory(const Twine &Path) {
291 return create_directory(Path, Existed);
294 /// @brief Create a hard link from \a from to \a to.
296 /// @param to The path to hard link to.
297 /// @param from The path to hard link from. This is created.
298 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
299 /// , otherwise a platform specific error_code.
300 error_code create_hard_link(const Twine &to, const Twine &from);
302 /// @brief Create a symbolic link from \a from to \a to.
304 /// @param to The path to symbolically link to.
305 /// @param from The path to symbolically link from. This is created.
306 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
307 /// otherwise a platform specific error_code.
308 error_code create_symlink(const Twine &to, const Twine &from);
310 /// @brief Get the current path.
312 /// @param result Holds the current path on return.
313 /// @returns errc::success if the current path has been stored in result,
314 /// otherwise a platform specific error_code.
315 error_code current_path(SmallVectorImpl<char> &result);
317 /// @brief Remove path. Equivalent to POSIX remove().
319 /// @param path Input path.
320 /// @param existed Set to true if \a path existed, false if it did not.
321 /// undefined otherwise.
322 /// @returns errc::success if path has been removed and existed has been
323 /// successfully set, otherwise a platform specific error_code.
324 error_code remove(const Twine &path, bool &existed);
326 /// @brief Convenience function for clients that don't need to know if the file
328 inline error_code remove(const Twine &Path) {
330 return remove(Path, Existed);
333 /// @brief Recursively remove all files below \a path, then \a path. Files are
334 /// removed as if by POSIX remove().
336 /// @param path Input path.
337 /// @param num_removed Number of files removed.
338 /// @returns errc::success if path has been removed and num_removed has been
339 /// successfully set, otherwise a platform specific error_code.
340 error_code remove_all(const Twine &path, uint32_t &num_removed);
342 /// @brief Convenience function for clients that don't need to know how many
343 /// files were removed.
344 inline error_code remove_all(const Twine &Path) {
346 return remove_all(Path, Removed);
349 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
351 /// @param from The path to rename from.
352 /// @param to The path to rename to. This is created.
353 error_code rename(const Twine &from, const Twine &to);
355 /// @brief Resize path to size. File is resized as if by POSIX truncate().
357 /// @param path Input path.
358 /// @param size Size to resize to.
359 /// @returns errc::success if \a path has been resized to \a size, otherwise a
360 /// platform specific error_code.
361 error_code resize_file(const Twine &path, uint64_t size);
364 /// @name Physical Observers
367 /// @brief Does file exist?
369 /// @param status A file_status previously returned from stat.
370 /// @returns True if the file represented by status exists, false if it does
372 bool exists(file_status status);
374 /// @brief Does file exist?
376 /// @param path Input path.
377 /// @param result Set to true if the file represented by status exists, false if
378 /// it does not. Undefined otherwise.
379 /// @returns errc::success if result has been successfully set, otherwise a
380 /// platform specific error_code.
381 error_code exists(const Twine &path, bool &result);
383 /// @brief Simpler version of exists for clients that don't need to
384 /// differentiate between an error and false.
385 inline bool exists(const Twine &path) {
387 return !exists(path, result) && result;
390 /// @brief Can we execute this file?
392 /// @param Path Input path.
393 /// @returns True if we can execute it, false otherwise.
394 bool can_execute(const Twine &Path);
396 /// @brief Can we write this file?
398 /// @param Path Input path.
399 /// @returns True if we can write to it, false otherwise.
400 bool can_write(const Twine &Path);
402 /// @brief Do file_status's represent the same thing?
404 /// @param A Input file_status.
405 /// @param B Input file_status.
407 /// assert(status_known(A) || status_known(B));
409 /// @returns True if A and B both represent the same file system entity, false
411 bool equivalent(file_status A, file_status B);
413 /// @brief Do paths represent the same thing?
415 /// assert(status_known(A) || status_known(B));
417 /// @param A Input path A.
418 /// @param B Input path B.
419 /// @param result Set to true if stat(A) and stat(B) have the same device and
420 /// inode (or equivalent).
421 /// @returns errc::success if result has been successfully set, otherwise a
422 /// platform specific error_code.
423 error_code equivalent(const Twine &A, const Twine &B, bool &result);
425 /// @brief Simpler version of equivalent for clients that don't need to
426 /// differentiate between an error and false.
427 inline bool equivalent(const Twine &A, const Twine &B) {
429 return !equivalent(A, B, result) && result;
432 /// @brief Get file size.
434 /// @param path Input path.
435 /// @param result Set to the size of the file in \a path.
436 /// @returns errc::success if result has been successfully set, otherwise a
437 /// platform specific error_code.
438 error_code file_size(const Twine &path, uint64_t &result);
440 /// @brief Does status represent a directory?
442 /// @param status A file_status previously returned from status.
443 /// @returns status.type() == file_type::directory_file.
444 bool is_directory(file_status status);
446 /// @brief Is path a directory?
448 /// @param path Input path.
449 /// @param result Set to true if \a path is a directory, false if it is not.
450 /// Undefined otherwise.
451 /// @returns errc::success if result has been successfully set, otherwise a
452 /// platform specific error_code.
453 error_code is_directory(const Twine &path, bool &result);
455 /// @brief Does status represent a regular file?
457 /// @param status A file_status previously returned from status.
458 /// @returns status_known(status) && status.type() == file_type::regular_file.
459 bool is_regular_file(file_status status);
461 /// @brief Is path a regular file?
463 /// @param path Input path.
464 /// @param result Set to true if \a path is a regular file, false if it is not.
465 /// Undefined otherwise.
466 /// @returns errc::success if result has been successfully set, otherwise a
467 /// platform specific error_code.
468 error_code is_regular_file(const Twine &path, bool &result);
470 /// @brief Simpler version of is_regular_file for clients that don't need to
471 /// differentiate between an error and false.
472 inline bool is_regular_file(const Twine &Path) {
474 if (is_regular_file(Path, Result))
479 /// @brief Does this status represent something that exists but is not a
480 /// directory, regular file, or symlink?
482 /// @param status A file_status previously returned from status.
483 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
485 bool is_other(file_status status);
487 /// @brief Is path something that exists but is not a directory,
488 /// regular file, or symlink?
490 /// @param path Input path.
491 /// @param result Set to true if \a path exists, but is not a directory, regular
492 /// file, or a symlink, false if it does not. Undefined otherwise.
493 /// @returns errc::success if result has been successfully set, otherwise a
494 /// platform specific error_code.
495 error_code is_other(const Twine &path, bool &result);
497 /// @brief Does status represent a symlink?
499 /// @param status A file_status previously returned from stat.
500 /// @returns status.type() == symlink_file.
501 bool is_symlink(file_status status);
503 /// @brief Is path a symlink?
505 /// @param path Input path.
506 /// @param result Set to true if \a path is a symlink, false if it is not.
507 /// Undefined otherwise.
508 /// @returns errc::success if result has been successfully set, otherwise a
509 /// platform specific error_code.
510 error_code is_symlink(const Twine &path, bool &result);
512 /// @brief Get file status as if by POSIX stat().
514 /// @param path Input path.
515 /// @param result Set to the file status.
516 /// @returns errc::success if result has been successfully set, otherwise a
517 /// platform specific error_code.
518 error_code status(const Twine &path, file_status &result);
520 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
522 /// @brief Is status available?
524 /// @param s Input file status.
525 /// @returns True if status() != status_error.
526 bool status_known(file_status s);
528 /// @brief Is status available?
530 /// @param path Input path.
531 /// @param result Set to true if status() != status_error.
532 /// @returns errc::success if result has been successfully set, otherwise a
533 /// platform specific error_code.
534 error_code status_known(const Twine &path, bool &result);
536 /// @brief Create a uniquely named file.
538 /// Generates a unique path suitable for a temporary file and then opens it as a
539 /// file. The name is based on \a model with '%' replaced by a random char in
540 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
541 /// directory will be prepended.
543 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
545 /// This is an atomic operation. Either the file is created and opened, or the
546 /// file system is left untouched.
548 /// The intendend use is for files that are to be kept, possibly after
549 /// renaming them. For example, when running 'clang -c foo.o', the file can
550 /// be first created as foo-abc123.o and then renamed.
552 /// @param Model Name to base unique path off of.
553 /// @param ResultFD Set to the opened file's file descriptor.
554 /// @param ResultPath Set to the opened file's absolute path.
555 /// @returns errc::success if Result{FD,Path} have been successfully set,
556 /// otherwise a platform specific error_code.
557 error_code createUniqueFile(const Twine &Model, int &ResultFD,
558 SmallVectorImpl<char> &ResultPath,
559 unsigned Mode = all_read | all_write);
561 /// @brief Simpler version for clients that don't want an open file.
562 error_code createUniqueFile(const Twine &Model,
563 SmallVectorImpl<char> &ResultPath);
565 /// @brief Create a file in the system temporary directory.
567 /// The filename is of the form prefix-random_chars.suffix. Since the directory
568 /// is not know to the caller, Prefix and Suffix cannot have path separators.
569 /// The files are created with mode 0600.
571 /// This should be used for things like a temporary .s that is removed after
572 /// running the assembler.
573 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
575 SmallVectorImpl<char> &ResultPath);
577 /// @brief Simpler version for clients that don't want an open file.
578 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
579 SmallVectorImpl<char> &ResultPath);
581 error_code createUniqueDirectory(const Twine &Prefix,
582 SmallVectorImpl<char> &ResultPath);
584 /// @brief Canonicalize path.
586 /// Sets result to the file system's idea of what path is. The result is always
587 /// absolute and has the same capitalization as the file system.
589 /// @param path Input path.
590 /// @param result Set to the canonicalized version of \a path.
591 /// @returns errc::success if result has been successfully set, otherwise a
592 /// platform specific error_code.
593 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
595 /// @brief Are \a path's first bytes \a magic?
597 /// @param path Input path.
598 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
599 /// @returns errc::success if result has been successfully set, otherwise a
600 /// platform specific error_code.
601 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
603 /// @brief Get \a path's first \a len bytes.
605 /// @param path Input path.
606 /// @param len Number of magic bytes to get.
607 /// @param result Set to the first \a len bytes in the file pointed to by
608 /// \a path. Or the entire file if file_size(path) < len, in which
609 /// case result.size() returns the size of the file.
610 /// @returns errc::success if result has been successfully set,
611 /// errc::value_too_large if len is larger then the file pointed to by
612 /// \a path, otherwise a platform specific error_code.
613 error_code get_magic(const Twine &path, uint32_t len,
614 SmallVectorImpl<char> &result);
616 /// @brief Identify the type of a binary file based on how magical it is.
617 file_magic identify_magic(StringRef magic);
619 /// @brief Get and identify \a path's type based on its content.
621 /// @param path Input path.
622 /// @param result Set to the type of file, or file_magic::unknown.
623 /// @returns errc::success if result has been successfully set, otherwise a
624 /// platform specific error_code.
625 error_code identify_magic(const Twine &path, file_magic &result);
627 error_code getUniqueID(const Twine Path, uint64_t &Result);
629 /// This class represents a memory mapped file. It is based on
630 /// boost::iostreams::mapped_file.
631 class mapped_file_region {
632 mapped_file_region() LLVM_DELETED_FUNCTION;
633 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
634 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
638 readonly, ///< May only access map via const_data as read only.
639 readwrite, ///< May access map via data and modify it. Written to path.
640 priv ///< May modify via data, but changes are lost on destruction.
644 /// Platform specific mapping state.
651 void *FileMappingHandle;
654 error_code init(int FD, bool CloseFD, uint64_t Offset);
657 typedef char char_type;
659 #if LLVM_HAS_RVALUE_REFERENCES
660 mapped_file_region(mapped_file_region&&);
661 mapped_file_region &operator =(mapped_file_region&&);
664 /// Construct a mapped_file_region at \a path starting at \a offset of length
665 /// \a length and with access \a mode.
667 /// \param path Path to the file to map. If it does not exist it will be
669 /// \param mode How to map the memory.
670 /// \param length Number of bytes to map in starting at \a offset. If the file
671 /// is shorter than this, it will be extended. If \a length is
672 /// 0, the entire file will be mapped.
673 /// \param offset Byte offset from the beginning of the file where the map
674 /// should begin. Must be a multiple of
675 /// mapped_file_region::alignment().
676 /// \param ec This is set to errc::success if the map was constructed
677 /// sucessfully. Otherwise it is set to a platform dependent error.
678 mapped_file_region(const Twine &path,
684 /// \param fd An open file descriptor to map. mapped_file_region takes
685 /// ownership if closefd is true. It must have been opended in the correct
687 mapped_file_region(int fd,
694 ~mapped_file_region();
696 mapmode flags() const;
697 uint64_t size() const;
700 /// Get a const view of the data. Modifying this memory has undefined
702 const char *const_data() const;
704 /// \returns The minimum alignment offset must be.
705 static int alignment();
708 /// @brief Memory maps the contents of a file
710 /// @param path Path to file to map.
711 /// @param file_offset Byte offset in file where mapping should begin.
712 /// @param size Byte length of range of the file to map.
713 /// @param map_writable If true, the file will be mapped in r/w such
714 /// that changes to the mapped buffer will be flushed back
715 /// to the file. If false, the file will be mapped read-only
716 /// and the buffer will be read-only.
717 /// @param result Set to the start address of the mapped buffer.
718 /// @returns errc::success if result has been successfully set, otherwise a
719 /// platform specific error_code.
720 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
721 bool map_writable, void *&result);
724 /// @brief Memory unmaps the contents of a file
726 /// @param base Pointer to the start of the buffer.
727 /// @param size Byte length of the range to unmmap.
728 /// @returns errc::success if result has been successfully set, otherwise a
729 /// platform specific error_code.
730 error_code unmap_file_pages(void *base, size_t size);
732 /// Return the path to the main executable, given the value of argv[0] from
733 /// program startup and the address of main itself. In extremis, this function
734 /// may fail and return an empty path.
735 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
741 /// directory_entry - A single entry in a directory. Caches the status either
742 /// from the result of the iteration syscall, or the first time status is
744 class directory_entry {
746 mutable file_status Status;
749 explicit directory_entry(const Twine &path, file_status st = file_status())
755 void assign(const Twine &path, file_status st = file_status()) {
760 void replace_filename(const Twine &filename, file_status st = file_status());
762 const std::string &path() const { return Path; }
763 error_code status(file_status &result) const;
765 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
766 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
767 bool operator< (const directory_entry& rhs) const;
768 bool operator<=(const directory_entry& rhs) const;
769 bool operator> (const directory_entry& rhs) const;
770 bool operator>=(const directory_entry& rhs) const;
776 error_code directory_iterator_construct(DirIterState&, StringRef);
777 error_code directory_iterator_increment(DirIterState&);
778 error_code directory_iterator_destruct(DirIterState&);
780 /// DirIterState - Keeps state for the directory_iterator. It is reference
781 /// counted in order to preserve InputIterator semantics on copy.
782 struct DirIterState : public RefCountedBase<DirIterState> {
784 : IterationHandle(0) {}
787 directory_iterator_destruct(*this);
790 intptr_t IterationHandle;
791 directory_entry CurrentEntry;
795 /// directory_iterator - Iterates through the entries in path. There is no
796 /// operator++ because we need an error_code. If it's really needed we can make
797 /// it call report_fatal_error on error.
798 class directory_iterator {
799 IntrusiveRefCntPtr<detail::DirIterState> State;
802 explicit directory_iterator(const Twine &path, error_code &ec) {
803 State = new detail::DirIterState;
804 SmallString<128> path_storage;
805 ec = detail::directory_iterator_construct(*State,
806 path.toStringRef(path_storage));
809 explicit directory_iterator(const directory_entry &de, error_code &ec) {
810 State = new detail::DirIterState;
811 ec = detail::directory_iterator_construct(*State, de.path());
814 /// Construct end iterator.
815 directory_iterator() : State(new detail::DirIterState) {}
817 // No operator++ because we need error_code.
818 directory_iterator &increment(error_code &ec) {
819 ec = directory_iterator_increment(*State);
823 const directory_entry &operator*() const { return State->CurrentEntry; }
824 const directory_entry *operator->() const { return &State->CurrentEntry; }
826 bool operator==(const directory_iterator &RHS) const {
827 return State->CurrentEntry == RHS.State->CurrentEntry;
830 bool operator!=(const directory_iterator &RHS) const {
831 return !(*this == RHS);
833 // Other members as required by
834 // C++ Std, 24.1.1 Input iterators [input.iterators]
838 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
839 /// reference counted in order to preserve InputIterator semantics on copy.
840 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
843 , HasNoPushRequest(false) {}
845 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
847 bool HasNoPushRequest;
851 /// recursive_directory_iterator - Same as directory_iterator except for it
852 /// recurses down into child directories.
853 class recursive_directory_iterator {
854 IntrusiveRefCntPtr<detail::RecDirIterState> State;
857 recursive_directory_iterator() {}
858 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
859 : State(new detail::RecDirIterState) {
860 State->Stack.push(directory_iterator(path, ec));
861 if (State->Stack.top() == directory_iterator())
864 // No operator++ because we need error_code.
865 recursive_directory_iterator &increment(error_code &ec) {
866 static const directory_iterator end_itr;
868 if (State->HasNoPushRequest)
869 State->HasNoPushRequest = false;
872 if ((ec = State->Stack.top()->status(st))) return *this;
873 if (is_directory(st)) {
874 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
875 if (ec) return *this;
876 if (State->Stack.top() != end_itr) {
884 while (!State->Stack.empty()
885 && State->Stack.top().increment(ec) == end_itr) {
890 // Check if we are done. If so, create an end iterator.
891 if (State->Stack.empty())
897 const directory_entry &operator*() const { return *State->Stack.top(); }
898 const directory_entry *operator->() const { return &*State->Stack.top(); }
901 /// Gets the current level. Starting path is at level 0.
902 int level() const { return State->Level; }
904 /// Returns true if no_push has been called for this directory_entry.
905 bool no_push_request() const { return State->HasNoPushRequest; }
908 /// Goes up one level if Level > 0.
910 assert(State && "Cannot pop and end itertor!");
911 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
913 static const directory_iterator end_itr;
917 report_fatal_error("Error incrementing directory iterator.");
920 } while (!State->Stack.empty()
921 && State->Stack.top().increment(ec) == end_itr);
923 // Check if we are done. If so, create an end iterator.
924 if (State->Stack.empty())
928 /// Does not go down into the current directory_entry.
929 void no_push() { State->HasNoPushRequest = true; }
931 bool operator==(const recursive_directory_iterator &RHS) const {
932 return State == RHS.State;
935 bool operator!=(const recursive_directory_iterator &RHS) const {
936 return !(*this == RHS);
938 // Other members as required by
939 // C++ Std, 24.1.1 Input iterators [input.iterators]
944 } // end namespace fs
945 } // end namespace sys
946 } // end namespace llvm