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/system_error.h"
43 #ifdef HAVE_SYS_STAT_H
51 /// file_type - An "enum class" enumeration for the file system's view of the
67 file_type(_ v) : v_(v) {}
68 explicit file_type(int v) : v_(_(v)) {}
69 operator int() const {return v_;}
75 /// copy_option - An "enum class" enumeration of copy semantics for copy
83 copy_option(_ v) : v_(v) {}
84 explicit copy_option(int v) : v_(_(v)) {}
85 operator int() const {return v_;}
91 /// 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_all = owner_all | group_all | others_all,
114 set_uid_on_exe = 04000,
115 set_gid_on_exe = 02000,
117 perms_mask = all_all | set_uid_on_exe | set_gid_on_exe | sticky_bit,
118 perms_not_known = 0xFFFF,
120 remove_perms = 0x2000,
121 symlink_perms = 0x4000
124 // Helper functions so that you can use & and | to manipulate perms bits:
125 inline perms operator|(perms l , perms r) {
126 return static_cast<perms>(
127 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
129 inline perms operator&(perms l , perms r) {
130 return static_cast<perms>(
131 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
133 inline perms &operator|=(perms &l, perms r) {
137 inline perms &operator&=(perms &l, perms r) {
141 inline perms operator~(perms x) {
142 return static_cast<perms>(~static_cast<unsigned short>(x));
147 /// file_status - Represents the result of a call to stat and friends. It has
148 /// a platform specific member to store the result.
151 #if defined(LLVM_ON_UNIX)
154 #elif defined (LLVM_ON_WIN32)
155 uint32_t LastWriteTimeHigh;
156 uint32_t LastWriteTimeLow;
157 uint32_t VolumeSerialNumber;
158 uint32_t FileSizeHigh;
159 uint32_t FileSizeLow;
160 uint32_t FileIndexHigh;
161 uint32_t FileIndexLow;
163 friend bool equivalent(file_status A, file_status B);
164 friend error_code status(const Twine &path, file_status &result);
168 explicit file_status(file_type v=file_type::status_error,
169 perms prms=perms_not_known)
170 : Type(v), Perms(prms) {}
173 file_type type() const { return Type; }
174 perms permissions() const { return Perms; }
177 void type(file_type v) { Type = v; }
178 void permissions(perms p) { Perms = p; }
181 /// file_magic - An "enum class" enumeration of file types based on magic (the first
182 /// N bytes of the file).
185 unknown = 0, ///< Unrecognized file
186 bitcode, ///< Bitcode file
187 archive, ///< ar style archive file
188 elf_relocatable, ///< ELF Relocatable object file
189 elf_executable, ///< ELF Executable image
190 elf_shared_object, ///< ELF dynamically linked shared lib
191 elf_core, ///< ELF core image
192 macho_object, ///< Mach-O Object file
193 macho_executable, ///< Mach-O Executable
194 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
195 macho_core, ///< Mach-O Core File
196 macho_preload_executable, ///< Mach-O Preloaded Executable
197 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
198 macho_dynamic_linker, ///< The Mach-O dynamic linker
199 macho_bundle, ///< Mach-O Bundle file
200 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
201 macho_dsym_companion, ///< Mach-O dSYM companion file
202 coff_object, ///< COFF object file
203 pecoff_executable ///< PECOFF executable file
206 bool is_object() const {
207 return V == unknown ? false : true;
210 file_magic() : V(unknown) {}
211 file_magic(Impl V) : V(V) {}
212 operator Impl() const { return V; }
219 /// @name Physical Operators
222 /// @brief Make \a path an absolute path.
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.
227 /// /absolute/path => /absolute/path
228 /// relative/../path => <current-directory>/relative/../path
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);
235 /// @brief Copy the file at \a from to the path \a to.
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
244 error_code copy_file(const Twine &from, const Twine &to,
245 copy_option copt = copy_option::fail_if_exists);
247 /// @brief Create all the non-existent directories in path.
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);
255 /// @brief Create the directory in path.
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);
263 /// @brief Create a hard link from \a from to \a to.
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);
271 /// @brief Create a symbolic link from \a from to \a to.
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);
279 /// @brief Get the current path.
281 /// @param result Holds the current path on return.
282 /// @returns 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);
286 /// @brief Remove path. Equivalent to POSIX remove().
288 /// @param path Input path.
289 /// @param existed Set to true if \a path existed, false if it did not.
290 /// undefined otherwise.
291 /// @returns 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);
295 /// @brief Recursively remove all files below \a path, then \a path. Files are
296 /// removed as if by POSIX remove().
298 /// @param path Input path.
299 /// @param num_removed Number of files removed.
300 /// @returns 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);
304 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
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);
310 /// @brief Resize path to size. File is resized as if by POSIX truncate().
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);
319 /// @name Physical Observers
322 /// @brief Does file exist?
324 /// @param status A file_status previously returned from stat.
325 /// @returns True if the file represented by status exists, false if it does
327 bool exists(file_status status);
329 /// @brief Does file exist?
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 /// @returns errc::success if result has been successfully set, otherwise a
335 /// platform specific error_code.
336 error_code exists(const Twine &path, bool &result);
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) {
342 return !exists(path, result) && result;
345 /// @brief Do file_status's represent the same thing?
347 /// @param A Input file_status.
348 /// @param B Input file_status.
350 /// assert(status_known(A) || status_known(B));
352 /// @returns True if A and B both represent the same file system entity, false
354 bool equivalent(file_status A, file_status B);
356 /// @brief Do paths represent the same thing?
358 /// assert(status_known(A) || status_known(B));
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 /// @returns 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);
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) {
372 return !equivalent(A, B, result) && result;
375 /// @brief Get file size.
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);
383 /// @brief Does status represent a directory?
385 /// @param status A file_status previously returned from status.
386 /// @returns status.type() == file_type::directory_file.
387 bool is_directory(file_status status);
389 /// @brief Is path a directory?
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 /// @returns 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);
398 /// @brief Does status represent a regular file?
400 /// @param status A file_status previously returned from status.
401 /// @returns status_known(status) && status.type() == file_type::regular_file.
402 bool is_regular_file(file_status status);
404 /// @brief Is path a regular file?
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 /// @returns 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);
413 /// @brief Does this status represent something that exists but is not a
414 /// directory, regular file, or symlink?
416 /// @param status A file_status previously returned from status.
417 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
419 bool is_other(file_status status);
421 /// @brief Is path something that exists but is not a directory,
422 /// regular file, or symlink?
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 /// @returns 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);
431 /// @brief Does status represent a symlink?
433 /// @param status A file_status previously returned from stat.
434 /// @returns status.type() == symlink_file.
435 bool is_symlink(file_status status);
437 /// @brief Is path a symlink?
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 /// @returns 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);
446 /// @brief Get file status as if by POSIX stat().
448 /// @param path Input path.
449 /// @param result Set to the file status.
450 /// @returns 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);
454 /// @brief Modifies permission bits on a file
456 /// @param path Input path.
457 /// @returns errc::success if permissions have been changed, otherwise a
458 /// platform specific error_code.
459 error_code permissions(const Twine &path, perms prms);
461 /// @brief Is status available?
463 /// @param s Input file status.
464 /// @returns True if status() != status_error.
465 bool status_known(file_status s);
467 /// @brief Is status available?
469 /// @param path Input path.
470 /// @param result Set to true if status() != status_error.
471 /// @returns 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);
475 /// @brief Generate a unique path and open it as a file.
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.
482 /// This is an atomic operation. Either the file is created and opened, or the
483 /// file system is left untouched.
485 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
487 /// @param model Name to base unique path off of.
488 /// @param result_fd 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 \a model is not an absolute path, a temp
491 /// directory will be prepended.
492 /// @returns 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);
498 /// @brief Canonicalize path.
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.
503 /// @param path Input path.
504 /// @param result Set to the canonicalized version of \a path.
505 /// @returns 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);
509 /// @brief Are \a path's first bytes \a magic?
511 /// @param path Input path.
512 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
513 /// @returns 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);
517 /// @brief Get \a path's first \a len bytes.
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 /// @returns 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);
530 /// @brief Identify the type of a binary file based on how magical it is.
531 file_magic identify_magic(StringRef magic);
533 /// @brief Get and identify \a path's type based on its content.
535 /// @param path Input path.
536 /// @param result Set to the type of file, or file_magic::unknown.
537 /// @returns 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);
541 /// @brief Get library paths the system linker uses.
543 /// @param result Set to the list of system library paths.
544 /// @returns errc::success if result has been successfully set, otherwise a
545 /// platform specific error_code.
546 error_code GetSystemLibraryPaths(SmallVectorImpl<std::string> &result);
548 /// @brief Get bitcode library paths the system linker uses
549 /// + LLVM_LIB_SEARCH_PATH + LLVM_LIBDIR.
551 /// @param result Set to the list of bitcode library paths.
552 /// @returns errc::success if result has been successfully set, otherwise a
553 /// platform specific error_code.
554 error_code GetBitcodeLibraryPaths(SmallVectorImpl<std::string> &result);
556 /// @brief Find a library.
558 /// Find the path to a library using its short name. Use the system
559 /// dependent library paths to locate the library.
561 /// c => /usr/lib/libc.so
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 /// @returns 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);
569 /// @brief Get absolute path of main executable.
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 /// @returns 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);
579 /// This class represents a memory mapped file. It is based on
580 /// boost::iostreams::mapped_file.
581 class mapped_file_region {
582 mapped_file_region() LLVM_DELETED_FUNCTION;
583 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
584 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
588 readonly, ///< May only access map via const_data as read only.
589 readwrite, ///< May access map via data and modify it. Written to path.
590 priv ///< May modify via data, but changes are lost on destruction.
594 /// Platform specific mapping state.
601 void *FileMappingHandle;
604 error_code init(int FD, bool CloseFD, uint64_t Offset);
607 typedef char char_type;
609 #if LLVM_HAS_RVALUE_REFERENCES
610 mapped_file_region(mapped_file_region&&);
611 mapped_file_region &operator =(mapped_file_region&&);
614 /// Construct a mapped_file_region at \a path starting at \a offset of length
615 /// \a length and with access \a mode.
617 /// \param path Path to the file to map. If it does not exist it will be
619 /// \param mode How to map the memory.
620 /// \param length Number of bytes to map in starting at \a offset. If the file
621 /// is shorter than this, it will be extended. If \a length is
622 /// 0, the entire file will be mapped.
623 /// \param offset Byte offset from the beginning of the file where the map
624 /// should begin. Must be a multiple of
625 /// mapped_file_region::alignment().
626 /// \param ec This is set to errc::success if the map was constructed
627 /// sucessfully. Otherwise it is set to a platform dependent error.
628 mapped_file_region(const Twine &path,
634 /// \param fd An open file descriptor to map. mapped_file_region takes
635 /// ownership if closefd is true. It must have been opended in the correct
637 mapped_file_region(int fd,
644 ~mapped_file_region();
646 mapmode flags() const;
647 uint64_t size() const;
650 /// Get a const view of the data. Modifying this memory has undefined
652 const char *const_data() const;
654 /// \returns The minimum alignment offset must be.
655 static int alignment();
658 /// @brief Memory maps the contents of a file
660 /// @param path Path to file to map.
661 /// @param file_offset Byte offset in file where mapping should begin.
662 /// @param size Byte length of range of the file to map.
663 /// @param map_writable If true, the file will be mapped in r/w such
664 /// that changes to the mapped buffer will be flushed back
665 /// to the file. If false, the file will be mapped read-only
666 /// and the buffer will be read-only.
667 /// @param result Set to the start address of the mapped buffer.
668 /// @returns errc::success if result has been successfully set, otherwise a
669 /// platform specific error_code.
670 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
671 bool map_writable, void *&result);
674 /// @brief Memory unmaps the contents of a file
676 /// @param base Pointer to the start of the buffer.
677 /// @param size Byte length of the range to unmmap.
678 /// @returns errc::success if result has been successfully set, otherwise a
679 /// platform specific error_code.
680 error_code unmap_file_pages(void *base, size_t size);
688 /// directory_entry - A single entry in a directory. Caches the status either
689 /// from the result of the iteration syscall, or the first time status is
691 class directory_entry {
693 mutable file_status Status;
696 explicit directory_entry(const Twine &path, file_status st = file_status())
702 void assign(const Twine &path, file_status st = file_status()) {
707 void replace_filename(const Twine &filename, file_status st = file_status());
709 const std::string &path() const { return Path; }
710 error_code status(file_status &result) const;
712 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
713 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
714 bool operator< (const directory_entry& rhs) const;
715 bool operator<=(const directory_entry& rhs) const;
716 bool operator> (const directory_entry& rhs) const;
717 bool operator>=(const directory_entry& rhs) const;
723 error_code directory_iterator_construct(DirIterState&, StringRef);
724 error_code directory_iterator_increment(DirIterState&);
725 error_code directory_iterator_destruct(DirIterState&);
727 /// DirIterState - Keeps state for the directory_iterator. It is reference
728 /// counted in order to preserve InputIterator semantics on copy.
729 struct DirIterState : public RefCountedBase<DirIterState> {
731 : IterationHandle(0) {}
734 directory_iterator_destruct(*this);
737 intptr_t IterationHandle;
738 directory_entry CurrentEntry;
742 /// directory_iterator - Iterates through the entries in path. There is no
743 /// operator++ because we need an error_code. If it's really needed we can make
744 /// it call report_fatal_error on error.
745 class directory_iterator {
746 IntrusiveRefCntPtr<detail::DirIterState> State;
749 explicit directory_iterator(const Twine &path, error_code &ec) {
750 State = new detail::DirIterState;
751 SmallString<128> path_storage;
752 ec = detail::directory_iterator_construct(*State,
753 path.toStringRef(path_storage));
756 explicit directory_iterator(const directory_entry &de, error_code &ec) {
757 State = new detail::DirIterState;
758 ec = detail::directory_iterator_construct(*State, de.path());
761 /// Construct end iterator.
762 directory_iterator() : State(new detail::DirIterState) {}
764 // No operator++ because we need error_code.
765 directory_iterator &increment(error_code &ec) {
766 ec = directory_iterator_increment(*State);
770 const directory_entry &operator*() const { return State->CurrentEntry; }
771 const directory_entry *operator->() const { return &State->CurrentEntry; }
773 bool operator==(const directory_iterator &RHS) const {
774 return State->CurrentEntry == RHS.State->CurrentEntry;
777 bool operator!=(const directory_iterator &RHS) const {
778 return !(*this == RHS);
780 // Other members as required by
781 // C++ Std, 24.1.1 Input iterators [input.iterators]
785 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
786 /// reference counted in order to preserve InputIterator semantics on copy.
787 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
790 , HasNoPushRequest(false) {}
792 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
794 bool HasNoPushRequest;
798 /// recursive_directory_iterator - Same as directory_iterator except for it
799 /// recurses down into child directories.
800 class recursive_directory_iterator {
801 IntrusiveRefCntPtr<detail::RecDirIterState> State;
804 recursive_directory_iterator() {}
805 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
806 : State(new detail::RecDirIterState) {
807 State->Stack.push(directory_iterator(path, ec));
808 if (State->Stack.top() == directory_iterator())
811 // No operator++ because we need error_code.
812 recursive_directory_iterator &increment(error_code &ec) {
813 static const directory_iterator end_itr;
815 if (State->HasNoPushRequest)
816 State->HasNoPushRequest = false;
819 if ((ec = State->Stack.top()->status(st))) return *this;
820 if (is_directory(st)) {
821 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
822 if (ec) return *this;
823 if (State->Stack.top() != end_itr) {
831 while (!State->Stack.empty()
832 && State->Stack.top().increment(ec) == end_itr) {
837 // Check if we are done. If so, create an end iterator.
838 if (State->Stack.empty())
844 const directory_entry &operator*() const { return *State->Stack.top(); }
845 const directory_entry *operator->() const { return &*State->Stack.top(); }
848 /// Gets the current level. Starting path is at level 0.
849 int level() const { return State->Level; }
851 /// Returns true if no_push has been called for this directory_entry.
852 bool no_push_request() const { return State->HasNoPushRequest; }
855 /// Goes up one level if Level > 0.
857 assert(State && "Cannot pop and end itertor!");
858 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
860 static const directory_iterator end_itr;
864 report_fatal_error("Error incrementing directory iterator.");
867 } while (!State->Stack.empty()
868 && State->Stack.top().increment(ec) == end_itr);
870 // Check if we are done. If so, create an end iterator.
871 if (State->Stack.empty())
875 /// Does not go down into the current directory_entry.
876 void no_push() { State->HasNoPushRequest = true; }
878 bool operator==(const recursive_directory_iterator &RHS) const {
879 return State == RHS.State;
882 bool operator!=(const recursive_directory_iterator &RHS) const {
883 return !(*this == RHS);
885 // Other members as required by
886 // C++ Std, 24.1.1 Input iterators [input.iterators]
891 } // end namespace fs
892 } // end namespace sys
893 } // end namespace llvm