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_FILE_SYSTEM_H
28 #define LLVM_SUPPORT_FILE_SYSTEM_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_executabl, ///< 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(_ v) : v_(v) {}
212 explicit file_magic(int v) : v_(_(v)) {}
213 operator int() const {return v_;}
220 /// @name Physical Operators
223 /// @brief Make \a path an absolute path.
225 /// Makes \a path absolute using the current directory if it is not already. An
226 /// empty \a path will result in the current directory.
228 /// /absolute/path => /absolute/path
229 /// relative/../path => <current-directory>/relative/../path
231 /// @param path A path that is modified to be an absolute path.
232 /// @returns errc::success if \a path has been made absolute, otherwise a
233 /// platform specific error_code.
234 error_code make_absolute(SmallVectorImpl<char> &path);
236 /// @brief Copy the file at \a from to the path \a to.
238 /// @param from The path to copy the file from.
239 /// @param to The path to copy the file to.
240 /// @param copt Behavior if \a to already exists.
241 /// @returns errc::success if the file has been successfully copied.
242 /// errc::file_exists if \a to already exists and \a copt ==
243 /// copy_option::fail_if_exists. Otherwise a platform specific
245 error_code copy_file(const Twine &from, const Twine &to,
246 copy_option copt = copy_option::fail_if_exists);
248 /// @brief Create all the non-existent directories in path.
250 /// @param path Directories to create.
251 /// @param existed Set to true if \a path already existed, false otherwise.
252 /// @returns errc::success if is_directory(path) and existed have been set,
253 /// otherwise a platform specific error_code.
254 error_code create_directories(const Twine &path, bool &existed);
256 /// @brief Create the directory in path.
258 /// @param path Directory to create.
259 /// @param existed Set to true if \a path already existed, false otherwise.
260 /// @returns errc::success if is_directory(path) and existed have been set,
261 /// otherwise a platform specific error_code.
262 error_code create_directory(const Twine &path, bool &existed);
264 /// @brief Create a hard link from \a from to \a to.
266 /// @param to The path to hard link to.
267 /// @param from The path to hard link from. This is created.
268 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
269 /// , otherwise a platform specific error_code.
270 error_code create_hard_link(const Twine &to, const Twine &from);
272 /// @brief Create a symbolic link from \a from to \a to.
274 /// @param to The path to symbolically link to.
275 /// @param from The path to symbolically link from. This is created.
276 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
277 /// otherwise a platform specific error_code.
278 error_code create_symlink(const Twine &to, const Twine &from);
280 /// @brief Get the current path.
282 /// @param result Holds the current path on return.
283 /// @returns errc::success if the current path has been stored in result,
284 /// otherwise a platform specific error_code.
285 error_code current_path(SmallVectorImpl<char> &result);
287 /// @brief Remove path. Equivalent to POSIX remove().
289 /// @param path Input path.
290 /// @param existed Set to true if \a path existed, false if it did not.
291 /// undefined otherwise.
292 /// @returns errc::success if path has been removed and existed has been
293 /// successfully set, otherwise a platform specific error_code.
294 error_code remove(const Twine &path, bool &existed);
296 /// @brief Recursively remove all files below \a path, then \a path. Files are
297 /// removed as if by POSIX remove().
299 /// @param path Input path.
300 /// @param num_removed Number of files removed.
301 /// @returns errc::success if path has been removed and num_removed has been
302 /// successfully set, otherwise a platform specific error_code.
303 error_code remove_all(const Twine &path, uint32_t &num_removed);
305 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
307 /// @param from The path to rename from.
308 /// @param to The path to rename to. This is created.
309 error_code rename(const Twine &from, const Twine &to);
311 /// @brief Resize path to size. File is resized as if by POSIX truncate().
313 /// @param path Input path.
314 /// @param size Size to resize to.
315 /// @returns errc::success if \a path has been resized to \a size, otherwise a
316 /// platform specific error_code.
317 error_code resize_file(const Twine &path, uint64_t size);
320 /// @name Physical Observers
323 /// @brief Does file exist?
325 /// @param status A file_status previously returned from stat.
326 /// @returns True if the file represented by status exists, false if it does
328 bool exists(file_status status);
330 /// @brief Does file exist?
332 /// @param path Input path.
333 /// @param result Set to true if the file represented by status exists, false if
334 /// it does not. Undefined otherwise.
335 /// @returns errc::success if result has been successfully set, otherwise a
336 /// platform specific error_code.
337 error_code exists(const Twine &path, bool &result);
339 /// @brief Simpler version of exists for clients that don't need to
340 /// differentiate between an error and false.
341 inline bool exists(const Twine &path) {
343 return !exists(path, result) && result;
346 /// @brief Do file_status's represent the same thing?
348 /// @param A Input file_status.
349 /// @param B Input file_status.
351 /// assert(status_known(A) || status_known(B));
353 /// @returns True if A and B both represent the same file system entity, false
355 bool equivalent(file_status A, file_status B);
357 /// @brief Do paths represent the same thing?
359 /// assert(status_known(A) || status_known(B));
361 /// @param A Input path A.
362 /// @param B Input path B.
363 /// @param result Set to true if stat(A) and stat(B) have the same device and
364 /// inode (or equivalent).
365 /// @returns errc::success if result has been successfully set, otherwise a
366 /// platform specific error_code.
367 error_code equivalent(const Twine &A, const Twine &B, bool &result);
369 /// @brief Simpler version of equivalent for clients that don't need to
370 /// differentiate between an error and false.
371 inline bool equivalent(const Twine &A, const Twine &B) {
373 return !equivalent(A, B, result) && result;
376 /// @brief Get file size.
378 /// @param path Input path.
379 /// @param result Set to the size of the file in \a path.
380 /// @returns errc::success if result has been successfully set, otherwise a
381 /// platform specific error_code.
382 error_code file_size(const Twine &path, uint64_t &result);
384 /// @brief Does status represent a directory?
386 /// @param status A file_status previously returned from status.
387 /// @returns status.type() == file_type::directory_file.
388 bool is_directory(file_status status);
390 /// @brief Is path a directory?
392 /// @param path Input path.
393 /// @param result Set to true if \a path is a directory, false if it is not.
394 /// Undefined otherwise.
395 /// @returns errc::success if result has been successfully set, otherwise a
396 /// platform specific error_code.
397 error_code is_directory(const Twine &path, bool &result);
399 /// @brief Does status represent a regular file?
401 /// @param status A file_status previously returned from status.
402 /// @returns status_known(status) && status.type() == file_type::regular_file.
403 bool is_regular_file(file_status status);
405 /// @brief Is path a regular file?
407 /// @param path Input path.
408 /// @param result Set to true if \a path is a regular file, false if it is not.
409 /// Undefined otherwise.
410 /// @returns errc::success if result has been successfully set, otherwise a
411 /// platform specific error_code.
412 error_code is_regular_file(const Twine &path, bool &result);
414 /// @brief Does this status represent something that exists but is not a
415 /// directory, regular file, or symlink?
417 /// @param status A file_status previously returned from status.
418 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
420 bool is_other(file_status status);
422 /// @brief Is path something that exists but is not a directory,
423 /// regular file, or symlink?
425 /// @param path Input path.
426 /// @param result Set to true if \a path exists, but is not a directory, regular
427 /// file, or a symlink, false if it does not. Undefined otherwise.
428 /// @returns errc::success if result has been successfully set, otherwise a
429 /// platform specific error_code.
430 error_code is_other(const Twine &path, bool &result);
432 /// @brief Does status represent a symlink?
434 /// @param status A file_status previously returned from stat.
435 /// @returns status.type() == symlink_file.
436 bool is_symlink(file_status status);
438 /// @brief Is path a symlink?
440 /// @param path Input path.
441 /// @param result Set to true if \a path is a symlink, false if it is not.
442 /// Undefined otherwise.
443 /// @returns errc::success if result has been successfully set, otherwise a
444 /// platform specific error_code.
445 error_code is_symlink(const Twine &path, bool &result);
447 /// @brief Get file status as if by POSIX stat().
449 /// @param path Input path.
450 /// @param result Set to the file status.
451 /// @returns errc::success if result has been successfully set, otherwise a
452 /// platform specific error_code.
453 error_code status(const Twine &path, file_status &result);
455 /// @brief Modifies permission bits on a file
457 /// @param path Input path.
458 /// @returns errc::success if permissions have been changed, otherwise a
459 /// platform specific error_code.
460 error_code permissions(const Twine &path, perms prms);
462 /// @brief Is status available?
464 /// @param s Input file status.
465 /// @returns True if status() != status_error.
466 bool status_known(file_status s);
468 /// @brief Is status available?
470 /// @param path Input path.
471 /// @param result Set to true if status() != status_error.
472 /// @returns errc::success if result has been successfully set, otherwise a
473 /// platform specific error_code.
474 error_code status_known(const Twine &path, bool &result);
476 /// @brief Generate a unique path and open it as a file.
478 /// Generates a unique path suitable for a temporary file and then opens it as a
479 /// file. The name is based on \a model with '%' replaced by a random char in
480 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
481 /// directory will be prepended.
483 /// This is an atomic operation. Either the file is created and opened, or the
484 /// file system is left untouched.
486 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
488 /// @param model Name to base unique path off of.
489 /// @param result_fd Set to the opened file's file descriptor.
490 /// @param result_path Set to the opened file's absolute path.
491 /// @param makeAbsolute If true and \a model is not an absolute path, a temp
492 /// directory will be prepended.
493 /// @returns errc::success if result_{fd,path} have been successfully set,
494 /// otherwise a platform specific error_code.
495 error_code unique_file(const Twine &model, int &result_fd,
496 SmallVectorImpl<char> &result_path,
497 bool makeAbsolute = true, unsigned mode = 0600);
499 /// @brief Canonicalize path.
501 /// Sets result to the file system's idea of what path is. The result is always
502 /// absolute and has the same capitalization as the file system.
504 /// @param path Input path.
505 /// @param result Set to the canonicalized version of \a path.
506 /// @returns errc::success if result has been successfully set, otherwise a
507 /// platform specific error_code.
508 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
510 /// @brief Are \a path's first bytes \a magic?
512 /// @param path Input path.
513 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
514 /// @returns errc::success if result has been successfully set, otherwise a
515 /// platform specific error_code.
516 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
518 /// @brief Get \a path's first \a len bytes.
520 /// @param path Input path.
521 /// @param len Number of magic bytes to get.
522 /// @param result Set to the first \a len bytes in the file pointed to by
523 /// \a path. Or the entire file if file_size(path) < len, in which
524 /// case result.size() returns the size of the file.
525 /// @returns errc::success if result has been successfully set,
526 /// errc::value_too_large if len is larger then the file pointed to by
527 /// \a path, otherwise a platform specific error_code.
528 error_code get_magic(const Twine &path, uint32_t len,
529 SmallVectorImpl<char> &result);
531 /// @brief Identify the type of a binary file based on how magical it is.
532 file_magic identify_magic(StringRef magic);
534 /// @brief Get and identify \a path's type based on its content.
536 /// @param path Input path.
537 /// @param result Set to the type of file, or LLVMFileType::Unknown_FileType.
538 /// @returns errc::success if result has been successfully set, otherwise a
539 /// platform specific error_code.
540 error_code identify_magic(const Twine &path, file_magic &result);
542 /// @brief Get library paths the system linker uses.
544 /// @param result Set to the list of system library paths.
545 /// @returns errc::success if result has been successfully set, otherwise a
546 /// platform specific error_code.
547 error_code GetSystemLibraryPaths(SmallVectorImpl<std::string> &result);
549 /// @brief Get bitcode library paths the system linker uses
550 /// + LLVM_LIB_SEARCH_PATH + LLVM_LIBDIR.
552 /// @param result Set to the list of bitcode library paths.
553 /// @returns errc::success if result has been successfully set, otherwise a
554 /// platform specific error_code.
555 error_code GetBitcodeLibraryPaths(SmallVectorImpl<std::string> &result);
557 /// @brief Find a library.
559 /// Find the path to a library using its short name. Use the system
560 /// dependent library paths to locate the library.
562 /// c => /usr/lib/libc.so
564 /// @param short_name Library name one would give to the system linker.
565 /// @param result Set to the absolute path \a short_name represents.
566 /// @returns errc::success if result has been successfully set, otherwise a
567 /// platform specific error_code.
568 error_code FindLibrary(const Twine &short_name, SmallVectorImpl<char> &result);
570 /// @brief Get absolute path of main executable.
572 /// @param argv0 The program name as it was spelled on the command line.
573 /// @param MainAddr Address of some symbol in the executable (not in a library).
574 /// @param result Set to the absolute path of the current executable.
575 /// @returns errc::success if result has been successfully set, otherwise a
576 /// platform specific error_code.
577 error_code GetMainExecutable(const char *argv0, void *MainAddr,
578 SmallVectorImpl<char> &result);
580 /// This class represents a memory mapped file. It is based on
581 /// boost::iostreams::mapped_file.
582 class mapped_file_region {
583 mapped_file_region() LLVM_DELETED_FUNCTION;
584 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
585 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
589 readonly, ///< May only access map via const_data as read only.
590 readwrite, ///< May access map via data and modify it. Written to path.
591 priv ///< May modify via data, but changes are lost on destruction.
595 /// Platform specific mapping state.
602 void *FileMappingHandle;
605 error_code init(int FD, uint64_t Offset);
608 typedef char char_type;
610 #if LLVM_USE_RVALUE_REFERENCES
611 mapped_file_region(mapped_file_region&&);
612 mapped_file_region &operator =(mapped_file_region&&);
615 /// Construct a mapped_file_region at \a path starting at \a offset of length
616 /// \a length and with access \a mode.
618 /// \param path Path to the file to map. If it does not exist it will be
620 /// \param mode How to map the memory.
621 /// \param length Number of bytes to map in starting at \a offset. If the file
622 /// is shorter than this, it will be extended. If \a length is
623 /// 0, the entire file will be mapped.
624 /// \param offset Byte offset from the beginning of the file where the map
625 /// should begin. Must be a multiple of
626 /// mapped_file_region::alignment().
627 /// \param ec This is set to errc::success if the map was constructed
628 /// sucessfully. Otherwise it is set to a platform dependent error.
629 mapped_file_region(const Twine &path,
635 /// \param fd An open file descriptor to map. mapped_file_region takes
636 /// ownership. It must have been opended in the correct mode.
637 mapped_file_region(int fd,
643 ~mapped_file_region();
645 mapmode flags() const;
646 uint64_t size() const;
649 /// Get a const view of the data. Modifying this memory has undefined
651 const char *const_data() const;
653 /// \returns The minimum alignment offset must be.
654 static int alignment();
657 /// @brief Memory maps the contents of a file
659 /// @param path Path to file to map.
660 /// @param file_offset Byte offset in file where mapping should begin.
661 /// @param size Byte length of range of the file to map.
662 /// @param map_writable If true, the file will be mapped in r/w such
663 /// that changes to the mapped buffer will be flushed back
664 /// to the file. If false, the file will be mapped read-only
665 /// and the buffer will be read-only.
666 /// @param result Set to the start address of the mapped buffer.
667 /// @returns errc::success if result has been successfully set, otherwise a
668 /// platform specific error_code.
669 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
670 bool map_writable, void *&result);
673 /// @brief Memory unmaps the contents of a file
675 /// @param base Pointer to the start of the buffer.
676 /// @param size Byte length of the range to unmmap.
677 /// @returns errc::success if result has been successfully set, otherwise a
678 /// platform specific error_code.
679 error_code unmap_file_pages(void *base, size_t size);
687 /// directory_entry - A single entry in a directory. Caches the status either
688 /// from the result of the iteration syscall, or the first time status is
690 class directory_entry {
692 mutable file_status Status;
695 explicit directory_entry(const Twine &path, file_status st = file_status())
701 void assign(const Twine &path, file_status st = file_status()) {
706 void replace_filename(const Twine &filename, file_status st = file_status());
708 const std::string &path() const { return Path; }
709 error_code status(file_status &result) const;
711 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
712 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
713 bool operator< (const directory_entry& rhs) const;
714 bool operator<=(const directory_entry& rhs) const;
715 bool operator> (const directory_entry& rhs) const;
716 bool operator>=(const directory_entry& rhs) const;
722 error_code directory_iterator_construct(DirIterState&, StringRef);
723 error_code directory_iterator_increment(DirIterState&);
724 error_code directory_iterator_destruct(DirIterState&);
726 /// DirIterState - Keeps state for the directory_iterator. It is reference
727 /// counted in order to preserve InputIterator semantics on copy.
728 struct DirIterState : public RefCountedBase<DirIterState> {
730 : IterationHandle(0) {}
733 directory_iterator_destruct(*this);
736 intptr_t IterationHandle;
737 directory_entry CurrentEntry;
741 /// directory_iterator - Iterates through the entries in path. There is no
742 /// operator++ because we need an error_code. If it's really needed we can make
743 /// it call report_fatal_error on error.
744 class directory_iterator {
745 IntrusiveRefCntPtr<detail::DirIterState> State;
748 explicit directory_iterator(const Twine &path, error_code &ec) {
749 State = new detail::DirIterState;
750 SmallString<128> path_storage;
751 ec = detail::directory_iterator_construct(*State,
752 path.toStringRef(path_storage));
755 explicit directory_iterator(const directory_entry &de, error_code &ec) {
756 State = new detail::DirIterState;
757 ec = detail::directory_iterator_construct(*State, de.path());
760 /// Construct end iterator.
761 directory_iterator() : State(new detail::DirIterState) {}
763 // No operator++ because we need error_code.
764 directory_iterator &increment(error_code &ec) {
765 ec = directory_iterator_increment(*State);
769 const directory_entry &operator*() const { return State->CurrentEntry; }
770 const directory_entry *operator->() const { return &State->CurrentEntry; }
772 bool operator==(const directory_iterator &RHS) const {
773 return State->CurrentEntry == RHS.State->CurrentEntry;
776 bool operator!=(const directory_iterator &RHS) const {
777 return !(*this == RHS);
779 // Other members as required by
780 // C++ Std, 24.1.1 Input iterators [input.iterators]
784 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
785 /// reference counted in order to preserve InputIterator semantics on copy.
786 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
789 , HasNoPushRequest(false) {}
791 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
793 bool HasNoPushRequest;
797 /// recursive_directory_iterator - Same as directory_iterator except for it
798 /// recurses down into child directories.
799 class recursive_directory_iterator {
800 IntrusiveRefCntPtr<detail::RecDirIterState> State;
803 recursive_directory_iterator() {}
804 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
805 : State(new detail::RecDirIterState) {
806 State->Stack.push(directory_iterator(path, ec));
807 if (State->Stack.top() == directory_iterator())
810 // No operator++ because we need error_code.
811 recursive_directory_iterator &increment(error_code &ec) {
812 static const directory_iterator end_itr;
814 if (State->HasNoPushRequest)
815 State->HasNoPushRequest = false;
818 if ((ec = State->Stack.top()->status(st))) return *this;
819 if (is_directory(st)) {
820 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
821 if (ec) return *this;
822 if (State->Stack.top() != end_itr) {
830 while (!State->Stack.empty()
831 && State->Stack.top().increment(ec) == end_itr) {
836 // Check if we are done. If so, create an end iterator.
837 if (State->Stack.empty())
843 const directory_entry &operator*() const { return *State->Stack.top(); }
844 const directory_entry *operator->() const { return &*State->Stack.top(); }
847 /// Gets the current level. Starting path is at level 0.
848 int level() const { return State->Level; }
850 /// Returns true if no_push has been called for this directory_entry.
851 bool no_push_request() const { return State->HasNoPushRequest; }
854 /// Goes up one level if Level > 0.
856 assert(State && "Cannot pop and end itertor!");
857 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
859 static const directory_iterator end_itr;
863 report_fatal_error("Error incrementing directory iterator.");
866 } while (!State->Stack.empty()
867 && State->Stack.top().increment(ec) == end_itr);
869 // Check if we are done. If so, create an end iterator.
870 if (State->Stack.empty())
874 /// Does not go down into the current directory_entry.
875 void no_push() { State->HasNoPushRequest = true; }
877 bool operator==(const recursive_directory_iterator &RHS) const {
878 return State == RHS.State;
881 bool operator!=(const recursive_directory_iterator &RHS) const {
882 return !(*this == RHS);
884 // Other members as required by
885 // C++ Std, 24.1.1 Input iterators [input.iterators]
890 } // end namespace fs
891 } // end namespace sys
892 } // end namespace llvm