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 macho_universal_binary, ///< Mach-O universal binary
203 coff_object, ///< COFF object file
204 pecoff_executable ///< PECOFF executable file
207 bool is_object() const {
208 return V == unknown ? false : true;
211 file_magic() : V(unknown) {}
212 file_magic(Impl V) : V(V) {}
213 operator Impl() 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 Convenience function for clients that don't need to know if the file
298 inline error_code remove(const Twine &Path) {
300 return remove(Path, Existed);
303 /// @brief Recursively remove all files below \a path, then \a path. Files are
304 /// removed as if by POSIX remove().
306 /// @param path Input path.
307 /// @param num_removed Number of files removed.
308 /// @returns errc::success if path has been removed and num_removed has been
309 /// successfully set, otherwise a platform specific error_code.
310 error_code remove_all(const Twine &path, uint32_t &num_removed);
312 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
314 /// @param from The path to rename from.
315 /// @param to The path to rename to. This is created.
316 error_code rename(const Twine &from, const Twine &to);
318 /// @brief Resize path to size. File is resized as if by POSIX truncate().
320 /// @param path Input path.
321 /// @param size Size to resize to.
322 /// @returns errc::success if \a path has been resized to \a size, otherwise a
323 /// platform specific error_code.
324 error_code resize_file(const Twine &path, uint64_t size);
327 /// @name Physical Observers
330 /// @brief Does file exist?
332 /// @param status A file_status previously returned from stat.
333 /// @returns True if the file represented by status exists, false if it does
335 bool exists(file_status status);
337 /// @brief Does file exist?
339 /// @param path Input path.
340 /// @param result Set to true if the file represented by status exists, false if
341 /// it does not. Undefined otherwise.
342 /// @returns errc::success if result has been successfully set, otherwise a
343 /// platform specific error_code.
344 error_code exists(const Twine &path, bool &result);
346 /// @brief Simpler version of exists for clients that don't need to
347 /// differentiate between an error and false.
348 inline bool exists(const Twine &path) {
350 return !exists(path, result) && result;
353 /// @brief Can we execute this file?
355 /// @param Path Input path.
356 /// @returns True if we can execute it, false otherwise.
357 bool can_execute(const Twine &Path);
359 /// @brief Do file_status's represent the same thing?
361 /// @param A Input file_status.
362 /// @param B Input file_status.
364 /// assert(status_known(A) || status_known(B));
366 /// @returns True if A and B both represent the same file system entity, false
368 bool equivalent(file_status A, file_status B);
370 /// @brief Do paths represent the same thing?
372 /// assert(status_known(A) || status_known(B));
374 /// @param A Input path A.
375 /// @param B Input path B.
376 /// @param result Set to true if stat(A) and stat(B) have the same device and
377 /// inode (or equivalent).
378 /// @returns errc::success if result has been successfully set, otherwise a
379 /// platform specific error_code.
380 error_code equivalent(const Twine &A, const Twine &B, bool &result);
382 /// @brief Simpler version of equivalent for clients that don't need to
383 /// differentiate between an error and false.
384 inline bool equivalent(const Twine &A, const Twine &B) {
386 return !equivalent(A, B, result) && result;
389 /// @brief Get file size.
391 /// @param path Input path.
392 /// @param result Set to the size of the file in \a path.
393 /// @returns errc::success if result has been successfully set, otherwise a
394 /// platform specific error_code.
395 error_code file_size(const Twine &path, uint64_t &result);
397 /// @brief Does status represent a directory?
399 /// @param status A file_status previously returned from status.
400 /// @returns status.type() == file_type::directory_file.
401 bool is_directory(file_status status);
403 /// @brief Is path a directory?
405 /// @param path Input path.
406 /// @param result Set to true if \a path is a directory, false if it is not.
407 /// Undefined otherwise.
408 /// @returns errc::success if result has been successfully set, otherwise a
409 /// platform specific error_code.
410 error_code is_directory(const Twine &path, bool &result);
412 /// @brief Does status represent a regular file?
414 /// @param status A file_status previously returned from status.
415 /// @returns status_known(status) && status.type() == file_type::regular_file.
416 bool is_regular_file(file_status status);
418 /// @brief Is path a regular file?
420 /// @param path Input path.
421 /// @param result Set to true if \a path is a regular file, false if it is not.
422 /// Undefined otherwise.
423 /// @returns errc::success if result has been successfully set, otherwise a
424 /// platform specific error_code.
425 error_code is_regular_file(const Twine &path, bool &result);
427 /// @brief Does this status represent something that exists but is not a
428 /// directory, regular file, or symlink?
430 /// @param status A file_status previously returned from status.
431 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
433 bool is_other(file_status status);
435 /// @brief Is path something that exists but is not a directory,
436 /// regular file, or symlink?
438 /// @param path Input path.
439 /// @param result Set to true if \a path exists, but is not a directory, regular
440 /// file, or a symlink, false if it does not. Undefined otherwise.
441 /// @returns errc::success if result has been successfully set, otherwise a
442 /// platform specific error_code.
443 error_code is_other(const Twine &path, bool &result);
445 /// @brief Does status represent a symlink?
447 /// @param status A file_status previously returned from stat.
448 /// @returns status.type() == symlink_file.
449 bool is_symlink(file_status status);
451 /// @brief Is path a symlink?
453 /// @param path Input path.
454 /// @param result Set to true if \a path is a symlink, false if it is not.
455 /// Undefined otherwise.
456 /// @returns errc::success if result has been successfully set, otherwise a
457 /// platform specific error_code.
458 error_code is_symlink(const Twine &path, bool &result);
460 /// @brief Get file status as if by POSIX stat().
462 /// @param path Input path.
463 /// @param result Set to the file status.
464 /// @returns errc::success if result has been successfully set, otherwise a
465 /// platform specific error_code.
466 error_code status(const Twine &path, file_status &result);
468 /// @brief Modifies permission bits on a file
470 /// @param path Input path.
471 /// @returns errc::success if permissions have been changed, otherwise a
472 /// platform specific error_code.
473 error_code permissions(const Twine &path, perms prms);
475 /// @brief Is status available?
477 /// @param s Input file status.
478 /// @returns True if status() != status_error.
479 bool status_known(file_status s);
481 /// @brief Is status available?
483 /// @param path Input path.
484 /// @param result Set to true if status() != status_error.
485 /// @returns errc::success if result has been successfully set, otherwise a
486 /// platform specific error_code.
487 error_code status_known(const Twine &path, bool &result);
489 /// @brief Generate a unique path and open it as a file.
491 /// Generates a unique path suitable for a temporary file and then opens it as a
492 /// file. The name is based on \a model with '%' replaced by a random char in
493 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
494 /// directory will be prepended.
496 /// This is an atomic operation. Either the file is created and opened, or the
497 /// file system is left untouched.
499 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
501 /// @param model Name to base unique path off of.
502 /// @param result_fd Set to the opened file's file descriptor.
503 /// @param result_path Set to the opened file's absolute path.
504 /// @param makeAbsolute If true and \a model is not an absolute path, a temp
505 /// directory will be prepended.
506 /// @returns errc::success if result_{fd,path} have been successfully set,
507 /// otherwise a platform specific error_code.
508 error_code unique_file(const Twine &model, int &result_fd,
509 SmallVectorImpl<char> &result_path,
510 bool makeAbsolute = true, unsigned mode = 0600);
512 /// @brief Simpler version for clients that don't want an open file.
513 error_code unique_file(const Twine &Model, SmallVectorImpl<char> &ResultPath,
514 bool MakeAbsolute = true, unsigned Mode = 0600);
516 /// @brief Canonicalize path.
518 /// Sets result to the file system's idea of what path is. The result is always
519 /// absolute and has the same capitalization as the file system.
521 /// @param path Input path.
522 /// @param result Set to the canonicalized version of \a path.
523 /// @returns errc::success if result has been successfully set, otherwise a
524 /// platform specific error_code.
525 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
527 /// @brief Are \a path's first bytes \a magic?
529 /// @param path Input path.
530 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
531 /// @returns errc::success if result has been successfully set, otherwise a
532 /// platform specific error_code.
533 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
535 /// @brief Get \a path's first \a len bytes.
537 /// @param path Input path.
538 /// @param len Number of magic bytes to get.
539 /// @param result Set to the first \a len bytes in the file pointed to by
540 /// \a path. Or the entire file if file_size(path) < len, in which
541 /// case result.size() returns the size of the file.
542 /// @returns errc::success if result has been successfully set,
543 /// errc::value_too_large if len is larger then the file pointed to by
544 /// \a path, otherwise a platform specific error_code.
545 error_code get_magic(const Twine &path, uint32_t len,
546 SmallVectorImpl<char> &result);
548 /// @brief Identify the type of a binary file based on how magical it is.
549 file_magic identify_magic(StringRef magic);
551 /// @brief Get and identify \a path's type based on its content.
553 /// @param path Input path.
554 /// @param result Set to the type of file, or file_magic::unknown.
555 /// @returns errc::success if result has been successfully set, otherwise a
556 /// platform specific error_code.
557 error_code identify_magic(const Twine &path, file_magic &result);
559 error_code GetUniqueID(const Twine Path, uint64_t &Result);
561 /// This class represents a memory mapped file. It is based on
562 /// boost::iostreams::mapped_file.
563 class mapped_file_region {
564 mapped_file_region() LLVM_DELETED_FUNCTION;
565 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
566 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
570 readonly, ///< May only access map via const_data as read only.
571 readwrite, ///< May access map via data and modify it. Written to path.
572 priv ///< May modify via data, but changes are lost on destruction.
576 /// Platform specific mapping state.
583 void *FileMappingHandle;
586 error_code init(int FD, bool CloseFD, uint64_t Offset);
589 typedef char char_type;
591 #if LLVM_HAS_RVALUE_REFERENCES
592 mapped_file_region(mapped_file_region&&);
593 mapped_file_region &operator =(mapped_file_region&&);
596 /// Construct a mapped_file_region at \a path starting at \a offset of length
597 /// \a length and with access \a mode.
599 /// \param path Path to the file to map. If it does not exist it will be
601 /// \param mode How to map the memory.
602 /// \param length Number of bytes to map in starting at \a offset. If the file
603 /// is shorter than this, it will be extended. If \a length is
604 /// 0, the entire file will be mapped.
605 /// \param offset Byte offset from the beginning of the file where the map
606 /// should begin. Must be a multiple of
607 /// mapped_file_region::alignment().
608 /// \param ec This is set to errc::success if the map was constructed
609 /// sucessfully. Otherwise it is set to a platform dependent error.
610 mapped_file_region(const Twine &path,
616 /// \param fd An open file descriptor to map. mapped_file_region takes
617 /// ownership if closefd is true. It must have been opended in the correct
619 mapped_file_region(int fd,
626 ~mapped_file_region();
628 mapmode flags() const;
629 uint64_t size() const;
632 /// Get a const view of the data. Modifying this memory has undefined
634 const char *const_data() const;
636 /// \returns The minimum alignment offset must be.
637 static int alignment();
640 /// @brief Memory maps the contents of a file
642 /// @param path Path to file to map.
643 /// @param file_offset Byte offset in file where mapping should begin.
644 /// @param size Byte length of range of the file to map.
645 /// @param map_writable If true, the file will be mapped in r/w such
646 /// that changes to the mapped buffer will be flushed back
647 /// to the file. If false, the file will be mapped read-only
648 /// and the buffer will be read-only.
649 /// @param result Set to the start address of the mapped buffer.
650 /// @returns errc::success if result has been successfully set, otherwise a
651 /// platform specific error_code.
652 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
653 bool map_writable, void *&result);
656 /// @brief Memory unmaps the contents of a file
658 /// @param base Pointer to the start of the buffer.
659 /// @param size Byte length of the range to unmmap.
660 /// @returns errc::success if result has been successfully set, otherwise a
661 /// platform specific error_code.
662 error_code unmap_file_pages(void *base, size_t size);
670 /// directory_entry - A single entry in a directory. Caches the status either
671 /// from the result of the iteration syscall, or the first time status is
673 class directory_entry {
675 mutable file_status Status;
678 explicit directory_entry(const Twine &path, file_status st = file_status())
684 void assign(const Twine &path, file_status st = file_status()) {
689 void replace_filename(const Twine &filename, file_status st = file_status());
691 const std::string &path() const { return Path; }
692 error_code status(file_status &result) const;
694 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
695 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
696 bool operator< (const directory_entry& rhs) const;
697 bool operator<=(const directory_entry& rhs) const;
698 bool operator> (const directory_entry& rhs) const;
699 bool operator>=(const directory_entry& rhs) const;
705 error_code directory_iterator_construct(DirIterState&, StringRef);
706 error_code directory_iterator_increment(DirIterState&);
707 error_code directory_iterator_destruct(DirIterState&);
709 /// DirIterState - Keeps state for the directory_iterator. It is reference
710 /// counted in order to preserve InputIterator semantics on copy.
711 struct DirIterState : public RefCountedBase<DirIterState> {
713 : IterationHandle(0) {}
716 directory_iterator_destruct(*this);
719 intptr_t IterationHandle;
720 directory_entry CurrentEntry;
724 /// directory_iterator - Iterates through the entries in path. There is no
725 /// operator++ because we need an error_code. If it's really needed we can make
726 /// it call report_fatal_error on error.
727 class directory_iterator {
728 IntrusiveRefCntPtr<detail::DirIterState> State;
731 explicit directory_iterator(const Twine &path, error_code &ec) {
732 State = new detail::DirIterState;
733 SmallString<128> path_storage;
734 ec = detail::directory_iterator_construct(*State,
735 path.toStringRef(path_storage));
738 explicit directory_iterator(const directory_entry &de, error_code &ec) {
739 State = new detail::DirIterState;
740 ec = detail::directory_iterator_construct(*State, de.path());
743 /// Construct end iterator.
744 directory_iterator() : State(new detail::DirIterState) {}
746 // No operator++ because we need error_code.
747 directory_iterator &increment(error_code &ec) {
748 ec = directory_iterator_increment(*State);
752 const directory_entry &operator*() const { return State->CurrentEntry; }
753 const directory_entry *operator->() const { return &State->CurrentEntry; }
755 bool operator==(const directory_iterator &RHS) const {
756 return State->CurrentEntry == RHS.State->CurrentEntry;
759 bool operator!=(const directory_iterator &RHS) const {
760 return !(*this == RHS);
762 // Other members as required by
763 // C++ Std, 24.1.1 Input iterators [input.iterators]
767 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
768 /// reference counted in order to preserve InputIterator semantics on copy.
769 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
772 , HasNoPushRequest(false) {}
774 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
776 bool HasNoPushRequest;
780 /// recursive_directory_iterator - Same as directory_iterator except for it
781 /// recurses down into child directories.
782 class recursive_directory_iterator {
783 IntrusiveRefCntPtr<detail::RecDirIterState> State;
786 recursive_directory_iterator() {}
787 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
788 : State(new detail::RecDirIterState) {
789 State->Stack.push(directory_iterator(path, ec));
790 if (State->Stack.top() == directory_iterator())
793 // No operator++ because we need error_code.
794 recursive_directory_iterator &increment(error_code &ec) {
795 static const directory_iterator end_itr;
797 if (State->HasNoPushRequest)
798 State->HasNoPushRequest = false;
801 if ((ec = State->Stack.top()->status(st))) return *this;
802 if (is_directory(st)) {
803 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
804 if (ec) return *this;
805 if (State->Stack.top() != end_itr) {
813 while (!State->Stack.empty()
814 && State->Stack.top().increment(ec) == end_itr) {
819 // Check if we are done. If so, create an end iterator.
820 if (State->Stack.empty())
826 const directory_entry &operator*() const { return *State->Stack.top(); }
827 const directory_entry *operator->() const { return &*State->Stack.top(); }
830 /// Gets the current level. Starting path is at level 0.
831 int level() const { return State->Level; }
833 /// Returns true if no_push has been called for this directory_entry.
834 bool no_push_request() const { return State->HasNoPushRequest; }
837 /// Goes up one level if Level > 0.
839 assert(State && "Cannot pop and end itertor!");
840 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
842 static const directory_iterator end_itr;
846 report_fatal_error("Error incrementing directory iterator.");
849 } while (!State->Stack.empty()
850 && State->Stack.top().increment(ec) == end_itr);
852 // Check if we are done. If so, create an end iterator.
853 if (State->Stack.empty())
857 /// Does not go down into the current directory_entry.
858 void no_push() { State->HasNoPushRequest = true; }
860 bool operator==(const recursive_directory_iterator &RHS) const {
861 return State == RHS.State;
864 bool operator!=(const recursive_directory_iterator &RHS) const {
865 return !(*this == RHS);
867 // Other members as required by
868 // C++ Std, 24.1.1 Input iterators [input.iterators]
873 } // end namespace fs
874 } // end namespace sys
875 } // end namespace llvm