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.
105 owner_all = owner_read | owner_write | owner_exe,
109 group_all = group_read | group_write | group_exe,
113 others_all = others_read | others_write | others_exe,
114 all_all = owner_all | group_all | others_all,
115 set_uid_on_exe = 04000,
116 set_gid_on_exe = 02000,
118 perms_mask = all_all | set_uid_on_exe | set_gid_on_exe | sticky_bit,
119 perms_not_known = 0xFFFF,
121 remove_perms = 0x2000,
122 symlink_perms = 0x4000
125 // Helper functions so that you can use & and | to manipulate perms bits:
126 inline perms operator|(perms l , perms r) {
127 return static_cast<perms>(
128 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
130 inline perms operator&(perms l , perms r) {
131 return static_cast<perms>(
132 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
134 inline perms &operator|=(perms &l, perms r) {
138 inline perms &operator&=(perms &l, perms r) {
142 inline perms operator~(perms x) {
143 return static_cast<perms>(~static_cast<unsigned short>(x));
148 /// file_status - Represents the result of a call to stat and friends. It has
149 /// a platform specific member to store the result.
152 #if defined(LLVM_ON_UNIX)
158 #elif defined (LLVM_ON_WIN32)
159 uint32_t LastWriteTimeHigh;
160 uint32_t LastWriteTimeLow;
161 uint32_t VolumeSerialNumber;
162 uint32_t FileSizeHigh;
163 uint32_t FileSizeLow;
164 uint32_t FileIndexHigh;
165 uint32_t FileIndexLow;
167 friend bool equivalent(file_status A, file_status B);
168 friend error_code status(const Twine &path, file_status &result);
169 friend error_code getUniqueID(const Twine Path, uint64_t &Result);
173 explicit file_status(file_type v=file_type::status_error,
174 perms prms=perms_not_known)
175 : Type(v), Perms(prms) {}
178 file_type type() const { return Type; }
179 perms permissions() const { return Perms; }
180 TimeValue getLastModificationTime() const;
182 #if defined(LLVM_ON_UNIX)
183 uint32_t getUser() const { return fs_st_uid; }
184 uint32_t getGroup() const { return fs_st_gid; }
185 #elif defined (LLVM_ON_WIN32)
186 uint32_t getUser() const {
187 return 9999; // Not applicable to Windows, so...
189 uint32_t getGroup() const {
190 return 9999; // Not applicable to Windows, so...
195 void type(file_type v) { Type = v; }
196 void permissions(perms p) { Perms = p; }
199 /// file_magic - An "enum class" enumeration of file types based on magic (the first
200 /// N bytes of the file).
203 unknown = 0, ///< Unrecognized file
204 bitcode, ///< Bitcode file
205 archive, ///< ar style archive file
206 elf_relocatable, ///< ELF Relocatable object file
207 elf_executable, ///< ELF Executable image
208 elf_shared_object, ///< ELF dynamically linked shared lib
209 elf_core, ///< ELF core image
210 macho_object, ///< Mach-O Object file
211 macho_executable, ///< Mach-O Executable
212 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
213 macho_core, ///< Mach-O Core File
214 macho_preload_executable, ///< Mach-O Preloaded Executable
215 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
216 macho_dynamic_linker, ///< The Mach-O dynamic linker
217 macho_bundle, ///< Mach-O Bundle file
218 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
219 macho_dsym_companion, ///< Mach-O dSYM companion file
220 macho_universal_binary, ///< Mach-O universal binary
221 coff_object, ///< COFF object file
222 pecoff_executable ///< PECOFF executable file
225 bool is_object() const {
226 return V == unknown ? false : true;
229 file_magic() : V(unknown) {}
230 file_magic(Impl V) : V(V) {}
231 operator Impl() const { return V; }
238 /// @name Physical Operators
241 /// @brief Make \a path an absolute path.
243 /// Makes \a path absolute using the current directory if it is not already. An
244 /// empty \a path will result in the current directory.
246 /// /absolute/path => /absolute/path
247 /// relative/../path => <current-directory>/relative/../path
249 /// @param path A path that is modified to be an absolute path.
250 /// @returns errc::success if \a path has been made absolute, otherwise a
251 /// platform specific error_code.
252 error_code make_absolute(SmallVectorImpl<char> &path);
254 /// @brief Copy the file at \a from to the path \a to.
256 /// @param from The path to copy the file from.
257 /// @param to The path to copy the file to.
258 /// @param copt Behavior if \a to already exists.
259 /// @returns errc::success if the file has been successfully copied.
260 /// errc::file_exists if \a to already exists and \a copt ==
261 /// copy_option::fail_if_exists. Otherwise a platform specific
263 error_code copy_file(const Twine &from, const Twine &to,
264 copy_option copt = copy_option::fail_if_exists);
266 /// @brief Create all the non-existent directories in path.
268 /// @param path Directories to create.
269 /// @param existed Set to true if \a path already existed, false otherwise.
270 /// @returns errc::success if is_directory(path) and existed have been set,
271 /// otherwise a platform specific error_code.
272 error_code create_directories(const Twine &path, bool &existed);
274 /// @brief Create the directory in path.
276 /// @param path Directory to create.
277 /// @param existed Set to true if \a path already existed, false otherwise.
278 /// @returns errc::success if is_directory(path) and existed have been set,
279 /// otherwise a platform specific error_code.
280 error_code create_directory(const Twine &path, bool &existed);
282 /// @brief Create a hard link from \a from to \a to.
284 /// @param to The path to hard link to.
285 /// @param from The path to hard link from. This is created.
286 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
287 /// , otherwise a platform specific error_code.
288 error_code create_hard_link(const Twine &to, const Twine &from);
290 /// @brief Create a symbolic link from \a from to \a to.
292 /// @param to The path to symbolically link to.
293 /// @param from The path to symbolically link from. This is created.
294 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
295 /// otherwise a platform specific error_code.
296 error_code create_symlink(const Twine &to, const Twine &from);
298 /// @brief Get the current path.
300 /// @param result Holds the current path on return.
301 /// @returns errc::success if the current path has been stored in result,
302 /// otherwise a platform specific error_code.
303 error_code current_path(SmallVectorImpl<char> &result);
305 /// @brief Remove path. Equivalent to POSIX remove().
307 /// @param path Input path.
308 /// @param existed Set to true if \a path existed, false if it did not.
309 /// undefined otherwise.
310 /// @returns errc::success if path has been removed and existed has been
311 /// successfully set, otherwise a platform specific error_code.
312 error_code remove(const Twine &path, bool &existed);
314 /// @brief Convenience function for clients that don't need to know if the file
316 inline error_code remove(const Twine &Path) {
318 return remove(Path, Existed);
321 /// @brief Recursively remove all files below \a path, then \a path. Files are
322 /// removed as if by POSIX remove().
324 /// @param path Input path.
325 /// @param num_removed Number of files removed.
326 /// @returns errc::success if path has been removed and num_removed has been
327 /// successfully set, otherwise a platform specific error_code.
328 error_code remove_all(const Twine &path, uint32_t &num_removed);
330 /// @brief Convenience function for clients that don't need to know how many
331 /// files were removed.
332 inline error_code remove_all(const Twine &Path) {
334 return remove_all(Path, Removed);
337 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
339 /// @param from The path to rename from.
340 /// @param to The path to rename to. This is created.
341 error_code rename(const Twine &from, const Twine &to);
343 /// @brief Resize path to size. File is resized as if by POSIX truncate().
345 /// @param path Input path.
346 /// @param size Size to resize to.
347 /// @returns errc::success if \a path has been resized to \a size, otherwise a
348 /// platform specific error_code.
349 error_code resize_file(const Twine &path, uint64_t size);
352 /// @name Physical Observers
355 /// @brief Does file exist?
357 /// @param status A file_status previously returned from stat.
358 /// @returns True if the file represented by status exists, false if it does
360 bool exists(file_status status);
362 /// @brief Does file exist?
364 /// @param path Input path.
365 /// @param result Set to true if the file represented by status exists, false if
366 /// it does not. Undefined otherwise.
367 /// @returns errc::success if result has been successfully set, otherwise a
368 /// platform specific error_code.
369 error_code exists(const Twine &path, bool &result);
371 /// @brief Simpler version of exists for clients that don't need to
372 /// differentiate between an error and false.
373 inline bool exists(const Twine &path) {
375 return !exists(path, result) && result;
378 /// @brief Can we execute this file?
380 /// @param Path Input path.
381 /// @returns True if we can execute it, false otherwise.
382 bool can_execute(const Twine &Path);
384 /// @brief Can we write this file?
386 /// @param Path Input path.
387 /// @returns True if we can write to it, false otherwise.
388 bool can_write(const Twine &Path);
390 /// @brief Do file_status's represent the same thing?
392 /// @param A Input file_status.
393 /// @param B Input file_status.
395 /// assert(status_known(A) || status_known(B));
397 /// @returns True if A and B both represent the same file system entity, false
399 bool equivalent(file_status A, file_status B);
401 /// @brief Do paths represent the same thing?
403 /// assert(status_known(A) || status_known(B));
405 /// @param A Input path A.
406 /// @param B Input path B.
407 /// @param result Set to true if stat(A) and stat(B) have the same device and
408 /// inode (or equivalent).
409 /// @returns errc::success if result has been successfully set, otherwise a
410 /// platform specific error_code.
411 error_code equivalent(const Twine &A, const Twine &B, bool &result);
413 /// @brief Simpler version of equivalent for clients that don't need to
414 /// differentiate between an error and false.
415 inline bool equivalent(const Twine &A, const Twine &B) {
417 return !equivalent(A, B, result) && result;
420 /// @brief Get file size.
422 /// @param path Input path.
423 /// @param result Set to the size of the file in \a path.
424 /// @returns errc::success if result has been successfully set, otherwise a
425 /// platform specific error_code.
426 error_code file_size(const Twine &path, uint64_t &result);
428 /// @brief Does status represent a directory?
430 /// @param status A file_status previously returned from status.
431 /// @returns status.type() == file_type::directory_file.
432 bool is_directory(file_status status);
434 /// @brief Is path a directory?
436 /// @param path Input path.
437 /// @param result Set to true if \a path is a directory, false if it is not.
438 /// Undefined otherwise.
439 /// @returns errc::success if result has been successfully set, otherwise a
440 /// platform specific error_code.
441 error_code is_directory(const Twine &path, bool &result);
443 /// @brief Does status represent a regular file?
445 /// @param status A file_status previously returned from status.
446 /// @returns status_known(status) && status.type() == file_type::regular_file.
447 bool is_regular_file(file_status status);
449 /// @brief Is path a regular file?
451 /// @param path Input path.
452 /// @param result Set to true if \a path is a regular file, false if it is not.
453 /// Undefined otherwise.
454 /// @returns errc::success if result has been successfully set, otherwise a
455 /// platform specific error_code.
456 error_code is_regular_file(const Twine &path, bool &result);
458 /// @brief Simpler version of is_regular_file for clients that don't need to
459 /// differentiate between an error and false.
460 inline bool is_regular_file(const Twine &Path) {
462 if (is_regular_file(Path, Result))
467 /// @brief Does this status represent something that exists but is not a
468 /// directory, regular file, or symlink?
470 /// @param status A file_status previously returned from status.
471 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
473 bool is_other(file_status status);
475 /// @brief Is path something that exists but is not a directory,
476 /// regular file, or symlink?
478 /// @param path Input path.
479 /// @param result Set to true if \a path exists, but is not a directory, regular
480 /// file, or a symlink, false if it does not. Undefined otherwise.
481 /// @returns errc::success if result has been successfully set, otherwise a
482 /// platform specific error_code.
483 error_code is_other(const Twine &path, bool &result);
485 /// @brief Does status represent a symlink?
487 /// @param status A file_status previously returned from stat.
488 /// @returns status.type() == symlink_file.
489 bool is_symlink(file_status status);
491 /// @brief Is path a symlink?
493 /// @param path Input path.
494 /// @param result Set to true if \a path is a symlink, false if it is not.
495 /// Undefined otherwise.
496 /// @returns errc::success if result has been successfully set, otherwise a
497 /// platform specific error_code.
498 error_code is_symlink(const Twine &path, bool &result);
500 /// @brief Get file status as if by POSIX stat().
502 /// @param path Input path.
503 /// @param result Set to the file status.
504 /// @returns errc::success if result has been successfully set, otherwise a
505 /// platform specific error_code.
506 error_code status(const Twine &path, file_status &result);
508 /// @brief Modifies permission bits on a file
510 /// @param path Input path.
511 /// @returns errc::success if permissions have been changed, otherwise a
512 /// platform specific error_code.
513 error_code permissions(const Twine &path, perms prms);
515 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
517 /// @brief Is status available?
519 /// @param s Input file status.
520 /// @returns True if status() != status_error.
521 bool status_known(file_status s);
523 /// @brief Is status available?
525 /// @param path Input path.
526 /// @param result Set to true if status() != status_error.
527 /// @returns errc::success if result has been successfully set, otherwise a
528 /// platform specific error_code.
529 error_code status_known(const Twine &path, bool &result);
531 /// @brief Generate a unique path and open it as a file.
533 /// Generates a unique path suitable for a temporary file and then opens it as a
534 /// file. The name is based on \a model with '%' replaced by a random char in
535 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
536 /// directory will be prepended.
538 /// This is an atomic operation. Either the file is created and opened, or the
539 /// file system is left untouched.
541 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
543 /// @param model Name to base unique path off of.
544 /// @param result_fd Set to the opened file's file descriptor.
545 /// @param result_path Set to the opened file's absolute path.
546 /// @param makeAbsolute If true and \a model is not an absolute path, a temp
547 /// directory will be prepended.
548 /// @returns errc::success if result_{fd,path} have been successfully set,
549 /// otherwise a platform specific error_code.
550 error_code unique_file(const Twine &model, int &result_fd,
551 SmallVectorImpl<char> &result_path,
552 bool makeAbsolute = true, unsigned mode = 0600);
554 /// @brief Simpler version for clients that don't want an open file.
555 error_code unique_file(const Twine &Model, SmallVectorImpl<char> &ResultPath,
556 bool MakeAbsolute = true, unsigned Mode = 0600);
558 /// @brief Canonicalize path.
560 /// Sets result to the file system's idea of what path is. The result is always
561 /// absolute and has the same capitalization as the file system.
563 /// @param path Input path.
564 /// @param result Set to the canonicalized version of \a path.
565 /// @returns errc::success if result has been successfully set, otherwise a
566 /// platform specific error_code.
567 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
569 /// @brief Are \a path's first bytes \a magic?
571 /// @param path Input path.
572 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
573 /// @returns errc::success if result has been successfully set, otherwise a
574 /// platform specific error_code.
575 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
577 /// @brief Get \a path's first \a len bytes.
579 /// @param path Input path.
580 /// @param len Number of magic bytes to get.
581 /// @param result Set to the first \a len bytes in the file pointed to by
582 /// \a path. Or the entire file if file_size(path) < len, in which
583 /// case result.size() returns the size of the file.
584 /// @returns errc::success if result has been successfully set,
585 /// errc::value_too_large if len is larger then the file pointed to by
586 /// \a path, otherwise a platform specific error_code.
587 error_code get_magic(const Twine &path, uint32_t len,
588 SmallVectorImpl<char> &result);
590 /// @brief Identify the type of a binary file based on how magical it is.
591 file_magic identify_magic(StringRef magic);
593 /// @brief Get and identify \a path's type based on its content.
595 /// @param path Input path.
596 /// @param result Set to the type of file, or file_magic::unknown.
597 /// @returns errc::success if result has been successfully set, otherwise a
598 /// platform specific error_code.
599 error_code identify_magic(const Twine &path, file_magic &result);
601 error_code getUniqueID(const Twine Path, uint64_t &Result);
603 /// This class represents a memory mapped file. It is based on
604 /// boost::iostreams::mapped_file.
605 class mapped_file_region {
606 mapped_file_region() LLVM_DELETED_FUNCTION;
607 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
608 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
612 readonly, ///< May only access map via const_data as read only.
613 readwrite, ///< May access map via data and modify it. Written to path.
614 priv ///< May modify via data, but changes are lost on destruction.
618 /// Platform specific mapping state.
625 void *FileMappingHandle;
628 error_code init(int FD, bool CloseFD, uint64_t Offset);
631 typedef char char_type;
633 #if LLVM_HAS_RVALUE_REFERENCES
634 mapped_file_region(mapped_file_region&&);
635 mapped_file_region &operator =(mapped_file_region&&);
638 /// Construct a mapped_file_region at \a path starting at \a offset of length
639 /// \a length and with access \a mode.
641 /// \param path Path to the file to map. If it does not exist it will be
643 /// \param mode How to map the memory.
644 /// \param length Number of bytes to map in starting at \a offset. If the file
645 /// is shorter than this, it will be extended. If \a length is
646 /// 0, the entire file will be mapped.
647 /// \param offset Byte offset from the beginning of the file where the map
648 /// should begin. Must be a multiple of
649 /// mapped_file_region::alignment().
650 /// \param ec This is set to errc::success if the map was constructed
651 /// sucessfully. Otherwise it is set to a platform dependent error.
652 mapped_file_region(const Twine &path,
658 /// \param fd An open file descriptor to map. mapped_file_region takes
659 /// ownership if closefd is true. It must have been opended in the correct
661 mapped_file_region(int fd,
668 ~mapped_file_region();
670 mapmode flags() const;
671 uint64_t size() const;
674 /// Get a const view of the data. Modifying this memory has undefined
676 const char *const_data() const;
678 /// \returns The minimum alignment offset must be.
679 static int alignment();
682 /// @brief Memory maps the contents of a file
684 /// @param path Path to file to map.
685 /// @param file_offset Byte offset in file where mapping should begin.
686 /// @param size Byte length of range of the file to map.
687 /// @param map_writable If true, the file will be mapped in r/w such
688 /// that changes to the mapped buffer will be flushed back
689 /// to the file. If false, the file will be mapped read-only
690 /// and the buffer will be read-only.
691 /// @param result Set to the start address of the mapped buffer.
692 /// @returns errc::success if result has been successfully set, otherwise a
693 /// platform specific error_code.
694 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
695 bool map_writable, void *&result);
698 /// @brief Memory unmaps the contents of a file
700 /// @param base Pointer to the start of the buffer.
701 /// @param size Byte length of the range to unmmap.
702 /// @returns errc::success if result has been successfully set, otherwise a
703 /// platform specific error_code.
704 error_code unmap_file_pages(void *base, size_t size);
706 /// Return the path to the main executable, given the value of argv[0] from
707 /// program startup and the address of main itself. In extremis, this function
708 /// may fail and return an empty path.
709 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
715 /// directory_entry - A single entry in a directory. Caches the status either
716 /// from the result of the iteration syscall, or the first time status is
718 class directory_entry {
720 mutable file_status Status;
723 explicit directory_entry(const Twine &path, file_status st = file_status())
729 void assign(const Twine &path, file_status st = file_status()) {
734 void replace_filename(const Twine &filename, file_status st = file_status());
736 const std::string &path() const { return Path; }
737 error_code status(file_status &result) const;
739 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
740 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
741 bool operator< (const directory_entry& rhs) const;
742 bool operator<=(const directory_entry& rhs) const;
743 bool operator> (const directory_entry& rhs) const;
744 bool operator>=(const directory_entry& rhs) const;
750 error_code directory_iterator_construct(DirIterState&, StringRef);
751 error_code directory_iterator_increment(DirIterState&);
752 error_code directory_iterator_destruct(DirIterState&);
754 /// DirIterState - Keeps state for the directory_iterator. It is reference
755 /// counted in order to preserve InputIterator semantics on copy.
756 struct DirIterState : public RefCountedBase<DirIterState> {
758 : IterationHandle(0) {}
761 directory_iterator_destruct(*this);
764 intptr_t IterationHandle;
765 directory_entry CurrentEntry;
769 /// directory_iterator - Iterates through the entries in path. There is no
770 /// operator++ because we need an error_code. If it's really needed we can make
771 /// it call report_fatal_error on error.
772 class directory_iterator {
773 IntrusiveRefCntPtr<detail::DirIterState> State;
776 explicit directory_iterator(const Twine &path, error_code &ec) {
777 State = new detail::DirIterState;
778 SmallString<128> path_storage;
779 ec = detail::directory_iterator_construct(*State,
780 path.toStringRef(path_storage));
783 explicit directory_iterator(const directory_entry &de, error_code &ec) {
784 State = new detail::DirIterState;
785 ec = detail::directory_iterator_construct(*State, de.path());
788 /// Construct end iterator.
789 directory_iterator() : State(new detail::DirIterState) {}
791 // No operator++ because we need error_code.
792 directory_iterator &increment(error_code &ec) {
793 ec = directory_iterator_increment(*State);
797 const directory_entry &operator*() const { return State->CurrentEntry; }
798 const directory_entry *operator->() const { return &State->CurrentEntry; }
800 bool operator==(const directory_iterator &RHS) const {
801 return State->CurrentEntry == RHS.State->CurrentEntry;
804 bool operator!=(const directory_iterator &RHS) const {
805 return !(*this == RHS);
807 // Other members as required by
808 // C++ Std, 24.1.1 Input iterators [input.iterators]
812 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
813 /// reference counted in order to preserve InputIterator semantics on copy.
814 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
817 , HasNoPushRequest(false) {}
819 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
821 bool HasNoPushRequest;
825 /// recursive_directory_iterator - Same as directory_iterator except for it
826 /// recurses down into child directories.
827 class recursive_directory_iterator {
828 IntrusiveRefCntPtr<detail::RecDirIterState> State;
831 recursive_directory_iterator() {}
832 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
833 : State(new detail::RecDirIterState) {
834 State->Stack.push(directory_iterator(path, ec));
835 if (State->Stack.top() == directory_iterator())
838 // No operator++ because we need error_code.
839 recursive_directory_iterator &increment(error_code &ec) {
840 static const directory_iterator end_itr;
842 if (State->HasNoPushRequest)
843 State->HasNoPushRequest = false;
846 if ((ec = State->Stack.top()->status(st))) return *this;
847 if (is_directory(st)) {
848 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
849 if (ec) return *this;
850 if (State->Stack.top() != end_itr) {
858 while (!State->Stack.empty()
859 && State->Stack.top().increment(ec) == end_itr) {
864 // Check if we are done. If so, create an end iterator.
865 if (State->Stack.empty())
871 const directory_entry &operator*() const { return *State->Stack.top(); }
872 const directory_entry *operator->() const { return &*State->Stack.top(); }
875 /// Gets the current level. Starting path is at level 0.
876 int level() const { return State->Level; }
878 /// Returns true if no_push has been called for this directory_entry.
879 bool no_push_request() const { return State->HasNoPushRequest; }
882 /// Goes up one level if Level > 0.
884 assert(State && "Cannot pop and end itertor!");
885 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
887 static const directory_iterator end_itr;
891 report_fatal_error("Error incrementing directory iterator.");
894 } while (!State->Stack.empty()
895 && State->Stack.top().increment(ec) == end_itr);
897 // Check if we are done. If so, create an end iterator.
898 if (State->Stack.empty())
902 /// Does not go down into the current directory_entry.
903 void no_push() { State->HasNoPushRequest = true; }
905 bool operator==(const recursive_directory_iterator &RHS) const {
906 return State == RHS.State;
909 bool operator!=(const recursive_directory_iterator &RHS) const {
910 return !(*this == RHS);
912 // Other members as required by
913 // C++ Std, 24.1.1 Input iterators [input.iterators]
918 } // end namespace fs
919 } // end namespace sys
920 } // end namespace llvm