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/SmallString.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Support/DataTypes.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/TimeValue.h"
40 #include <system_error>
44 #ifdef HAVE_SYS_STAT_H
52 /// An enumeration for the file system's view of the type.
53 enum class file_type {
66 /// space_info - Self explanatory.
78 owner_all = owner_read | owner_write | owner_exe,
82 group_all = group_read | group_write | group_exe,
86 others_all = others_read | others_write | others_exe,
87 all_read = owner_read | group_read | others_read,
88 all_write = owner_write | group_write | others_write,
89 all_exe = owner_exe | group_exe | others_exe,
90 all_all = owner_all | group_all | others_all,
91 set_uid_on_exe = 04000,
92 set_gid_on_exe = 02000,
94 perms_not_known = 0xFFFF
97 // Helper functions so that you can use & and | to manipulate perms bits:
98 inline perms operator|(perms l, perms r) {
99 return static_cast<perms>(static_cast<unsigned short>(l) |
100 static_cast<unsigned short>(r));
102 inline perms operator&(perms l, perms r) {
103 return static_cast<perms>(static_cast<unsigned short>(l) &
104 static_cast<unsigned short>(r));
106 inline perms &operator|=(perms &l, perms r) {
110 inline perms &operator&=(perms &l, perms r) {
114 inline perms operator~(perms x) {
115 return static_cast<perms>(~static_cast<unsigned short>(x));
123 UniqueID() = default;
124 UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
125 bool operator==(const UniqueID &Other) const {
126 return Device == Other.Device && File == Other.File;
128 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
129 bool operator<(const UniqueID &Other) const {
130 return std::tie(Device, File) < std::tie(Other.Device, Other.File);
132 uint64_t getDevice() const { return Device; }
133 uint64_t getFile() const { return File; }
136 /// file_status - Represents the result of a call to stat and friends. It has
137 /// a platform-specific member to store the result.
140 #if defined(LLVM_ON_UNIX)
147 #elif defined (LLVM_ON_WIN32)
148 uint32_t LastWriteTimeHigh;
149 uint32_t LastWriteTimeLow;
150 uint32_t VolumeSerialNumber;
151 uint32_t FileSizeHigh;
152 uint32_t FileSizeLow;
153 uint32_t FileIndexHigh;
154 uint32_t FileIndexLow;
156 friend bool equivalent(file_status A, file_status B);
161 #if defined(LLVM_ON_UNIX)
162 file_status() : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
163 fs_st_uid(0), fs_st_gid(0), fs_st_size(0),
164 Type(file_type::status_error), Perms(perms_not_known) {}
166 file_status(file_type Type) : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
167 fs_st_uid(0), fs_st_gid(0), fs_st_size(0), Type(Type),
168 Perms(perms_not_known) {}
170 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
171 uid_t UID, gid_t GID, off_t Size)
172 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
173 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
174 #elif defined(LLVM_ON_WIN32)
175 file_status() : LastWriteTimeHigh(0), LastWriteTimeLow(0),
176 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
177 FileIndexHigh(0), FileIndexLow(0), Type(file_type::status_error),
178 Perms(perms_not_known) {}
180 file_status(file_type Type) : LastWriteTimeHigh(0), LastWriteTimeLow(0),
181 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
182 FileIndexHigh(0), FileIndexLow(0), Type(Type),
183 Perms(perms_not_known) {}
185 file_status(file_type Type, uint32_t LastWriteTimeHigh,
186 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
187 uint32_t FileSizeHigh, uint32_t FileSizeLow,
188 uint32_t FileIndexHigh, uint32_t FileIndexLow)
189 : LastWriteTimeHigh(LastWriteTimeHigh),
190 LastWriteTimeLow(LastWriteTimeLow),
191 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
192 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
193 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
197 file_type type() const { return Type; }
198 perms permissions() const { return Perms; }
199 TimeValue getLastModificationTime() const;
200 UniqueID getUniqueID() const;
202 #if defined(LLVM_ON_UNIX)
203 uint32_t getUser() const { return fs_st_uid; }
204 uint32_t getGroup() const { return fs_st_gid; }
205 uint64_t getSize() const { return fs_st_size; }
206 #elif defined (LLVM_ON_WIN32)
207 uint32_t getUser() const {
208 return 9999; // Not applicable to Windows, so...
210 uint32_t getGroup() const {
211 return 9999; // Not applicable to Windows, so...
213 uint64_t getSize() const {
214 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
219 void type(file_type v) { Type = v; }
220 void permissions(perms p) { Perms = p; }
223 /// file_magic - An "enum class" enumeration of file types based on magic (the first
224 /// N bytes of the file).
227 unknown = 0, ///< Unrecognized file
228 bitcode, ///< Bitcode file
229 archive, ///< ar style archive file
230 elf, ///< ELF Unknown type
231 elf_relocatable, ///< ELF Relocatable object file
232 elf_executable, ///< ELF Executable image
233 elf_shared_object, ///< ELF dynamically linked shared lib
234 elf_core, ///< ELF core image
235 macho_object, ///< Mach-O Object file
236 macho_executable, ///< Mach-O Executable
237 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
238 macho_core, ///< Mach-O Core File
239 macho_preload_executable, ///< Mach-O Preloaded Executable
240 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
241 macho_dynamic_linker, ///< The Mach-O dynamic linker
242 macho_bundle, ///< Mach-O Bundle file
243 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
244 macho_dsym_companion, ///< Mach-O dSYM companion file
245 macho_kext_bundle, ///< Mach-O kext bundle file
246 macho_universal_binary, ///< Mach-O universal binary
247 coff_object, ///< COFF object file
248 coff_import_library, ///< COFF import library
249 pecoff_executable, ///< PECOFF executable file
250 windows_resource ///< Windows compiled resource file (.rc)
253 bool is_object() const {
254 return V == unknown ? false : true;
257 file_magic() : V(unknown) {}
258 file_magic(Impl V) : V(V) {}
259 operator Impl() const { return V; }
266 /// @name Physical Operators
269 /// @brief Make \a path an absolute path.
271 /// Makes \a path absolute using the current directory if it is not already. An
272 /// empty \a path will result in the current directory.
274 /// /absolute/path => /absolute/path
275 /// relative/../path => <current-directory>/relative/../path
277 /// @param path A path that is modified to be an absolute path.
278 /// @returns errc::success if \a path has been made absolute, otherwise a
279 /// platform-specific error_code.
280 std::error_code make_absolute(SmallVectorImpl<char> &path);
282 /// @brief Create all the non-existent directories in path.
284 /// @param path Directories to create.
285 /// @returns errc::success if is_directory(path), otherwise a platform
286 /// specific error_code. If IgnoreExisting is false, also returns
287 /// error if the directory already existed.
288 std::error_code create_directories(const Twine &path,
289 bool IgnoreExisting = true,
290 perms Perms = owner_all | group_all);
292 /// @brief Create the directory in path.
294 /// @param path Directory to create.
295 /// @returns errc::success if is_directory(path), otherwise a platform
296 /// specific error_code. If IgnoreExisting is false, also returns
297 /// error if the directory already existed.
298 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true,
299 perms Perms = owner_all | group_all);
301 /// @brief Create a link from \a from to \a to.
303 /// The link may be a soft or a hard link, depending on the platform. The caller
304 /// may not assume which one. Currently on windows it creates a hard link since
305 /// soft links require extra privileges. On unix, it creates a soft link since
306 /// hard links don't work on SMB file systems.
308 /// @param to The path to hard link to.
309 /// @param from The path to hard link from. This is created.
310 /// @returns errc::success if the link was created, otherwise a platform
311 /// specific error_code.
312 std::error_code create_link(const Twine &to, const Twine &from);
314 /// @brief Get the current path.
316 /// @param result Holds the current path on return.
317 /// @returns errc::success if the current path has been stored in result,
318 /// otherwise a platform-specific error_code.
319 std::error_code current_path(SmallVectorImpl<char> &result);
321 /// @brief Remove path. Equivalent to POSIX remove().
323 /// @param path Input path.
324 /// @returns errc::success if path has been removed or didn't exist, otherwise a
325 /// platform-specific error code. If IgnoreNonExisting is false, also
326 /// returns error if the file didn't exist.
327 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
329 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
331 /// @param from The path to rename from.
332 /// @param to The path to rename to. This is created.
333 std::error_code rename(const Twine &from, const Twine &to);
335 /// @brief Copy the contents of \a From to \a To.
337 /// @param From The path to copy from.
338 /// @param To The path to copy to. This is created.
339 std::error_code copy_file(const Twine &From, const Twine &To);
341 /// @brief Resize path to size. File is resized as if by POSIX truncate().
343 /// @param FD Input file descriptor.
344 /// @param Size Size to resize to.
345 /// @returns errc::success if \a path has been resized to \a size, otherwise a
346 /// platform-specific error_code.
347 std::error_code resize_file(int FD, uint64_t Size);
350 /// @name Physical Observers
353 /// @brief Does file exist?
355 /// @param status A file_status previously returned from stat.
356 /// @returns True if the file represented by status exists, false if it does
358 bool exists(file_status status);
360 enum class AccessMode { Exist, Write, Execute };
362 /// @brief Can the file be accessed?
364 /// @param Path Input path.
365 /// @returns errc::success if the path can be accessed, otherwise a
366 /// platform-specific error_code.
367 std::error_code access(const Twine &Path, AccessMode Mode);
369 /// @brief Does file exist?
371 /// @param Path Input path.
372 /// @returns True if it exists, false otherwise.
373 inline bool exists(const Twine &Path) {
374 return !access(Path, AccessMode::Exist);
377 /// @brief Can we execute this file?
379 /// @param Path Input path.
380 /// @returns True if we can execute it, false otherwise.
381 bool can_execute(const Twine &Path);
383 /// @brief Can we write this file?
385 /// @param Path Input path.
386 /// @returns True if we can write to it, false otherwise.
387 inline bool can_write(const Twine &Path) {
388 return !access(Path, AccessMode::Write);
391 /// @brief Do file_status's represent the same thing?
393 /// @param A Input file_status.
394 /// @param B Input file_status.
396 /// assert(status_known(A) || status_known(B));
398 /// @returns True if A and B both represent the same file system entity, false
400 bool equivalent(file_status A, file_status B);
402 /// @brief Do paths represent the same thing?
404 /// assert(status_known(A) || status_known(B));
406 /// @param A Input path A.
407 /// @param B Input path B.
408 /// @param result Set to true if stat(A) and stat(B) have the same device and
409 /// inode (or equivalent).
410 /// @returns errc::success if result has been successfully set, otherwise a
411 /// platform-specific error_code.
412 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
414 /// @brief Simpler version of equivalent for clients that don't need to
415 /// differentiate between an error and false.
416 inline bool equivalent(const Twine &A, const Twine &B) {
418 return !equivalent(A, B, result) && result;
421 /// @brief Does status represent a directory?
423 /// @param status A file_status previously returned from status.
424 /// @returns status.type() == file_type::directory_file.
425 bool is_directory(file_status status);
427 /// @brief Is path a directory?
429 /// @param path Input path.
430 /// @param result Set to true if \a path is a directory, false if it is not.
431 /// Undefined otherwise.
432 /// @returns errc::success if result has been successfully set, otherwise a
433 /// platform-specific error_code.
434 std::error_code is_directory(const Twine &path, bool &result);
436 /// @brief Simpler version of is_directory for clients that don't need to
437 /// differentiate between an error and false.
438 inline bool is_directory(const Twine &Path) {
440 return !is_directory(Path, Result) && 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 std::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)
472 bool is_other(file_status status);
474 /// @brief Is path something that exists but is not a directory,
475 /// regular file, or symlink?
477 /// @param path Input path.
478 /// @param result Set to true if \a path exists, but is not a directory, regular
479 /// file, or a symlink, false if it does not. Undefined otherwise.
480 /// @returns errc::success if result has been successfully set, otherwise a
481 /// platform-specific error_code.
482 std::error_code is_other(const Twine &path, bool &result);
484 /// @brief Get file status as if by POSIX stat().
486 /// @param path Input path.
487 /// @param result Set to the file status.
488 /// @returns errc::success if result has been successfully set, otherwise a
489 /// platform-specific error_code.
490 std::error_code status(const Twine &path, file_status &result);
492 /// @brief A version for when a file descriptor is already available.
493 std::error_code status(int FD, file_status &Result);
495 /// @brief Get file size.
497 /// @param Path Input path.
498 /// @param Result Set to the size of the file in \a Path.
499 /// @returns errc::success if result has been successfully set, otherwise a
500 /// platform-specific error_code.
501 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
503 std::error_code EC = status(Path, Status);
506 Result = Status.getSize();
507 return std::error_code();
510 /// @brief Set the file modification and access time.
512 /// @returns errc::success if the file times were successfully set, otherwise a
513 /// platform-specific error_code or errc::function_not_supported on
514 /// platforms where the functionality isn't available.
515 std::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 std::error_code status_known(const Twine &path, bool &result);
531 /// @brief Create a uniquely named 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 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
540 /// This is an atomic operation. Either the file is created and opened, or the
541 /// file system is left untouched.
543 /// The intendend use is for files that are to be kept, possibly after
544 /// renaming them. For example, when running 'clang -c foo.o', the file can
545 /// be first created as foo-abc123.o and then renamed.
547 /// @param Model Name to base unique path off of.
548 /// @param ResultFD Set to the opened file's file descriptor.
549 /// @param ResultPath Set to the opened file's absolute path.
550 /// @returns errc::success if Result{FD,Path} have been successfully set,
551 /// otherwise a platform-specific error_code.
552 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
553 SmallVectorImpl<char> &ResultPath,
554 unsigned Mode = all_read | all_write);
556 /// @brief Simpler version for clients that don't want an open file.
557 std::error_code createUniqueFile(const Twine &Model,
558 SmallVectorImpl<char> &ResultPath);
560 /// @brief Create a file in the system temporary directory.
562 /// The filename is of the form prefix-random_chars.suffix. Since the directory
563 /// is not know to the caller, Prefix and Suffix cannot have path separators.
564 /// The files are created with mode 0600.
566 /// This should be used for things like a temporary .s that is removed after
567 /// running the assembler.
568 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
570 SmallVectorImpl<char> &ResultPath);
572 /// @brief Simpler version for clients that don't want an open file.
573 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
574 SmallVectorImpl<char> &ResultPath);
576 std::error_code createUniqueDirectory(const Twine &Prefix,
577 SmallVectorImpl<char> &ResultPath);
579 enum OpenFlags : unsigned {
582 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
583 /// report an error if the file already exists.
586 /// F_Append - When opening a file, if it already exists append to the
587 /// existing file instead of returning an error. This may not be specified
591 /// The file should be opened in text mode on platforms that make this
595 /// Open the file for read and write.
599 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
600 return OpenFlags(unsigned(A) | unsigned(B));
603 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
608 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
609 OpenFlags Flags, unsigned Mode = 0666);
611 std::error_code openFileForRead(const Twine &Name, int &ResultFD);
613 /// @brief Identify the type of a binary file based on how magical it is.
614 file_magic identify_magic(StringRef magic);
616 /// @brief Get and identify \a path's type based on its content.
618 /// @param path Input path.
619 /// @param result Set to the type of file, or file_magic::unknown.
620 /// @returns errc::success if result has been successfully set, otherwise a
621 /// platform-specific error_code.
622 std::error_code identify_magic(const Twine &path, file_magic &result);
624 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
626 /// This class represents a memory mapped file. It is based on
627 /// boost::iostreams::mapped_file.
628 class mapped_file_region {
629 mapped_file_region() = delete;
630 mapped_file_region(mapped_file_region&) = delete;
631 mapped_file_region &operator =(mapped_file_region&) = delete;
635 readonly, ///< May only access map via const_data as read only.
636 readwrite, ///< May access map via data and modify it. Written to path.
637 priv ///< May modify via data, but changes are lost on destruction.
641 /// Platform-specific mapping state.
645 std::error_code init(int FD, uint64_t Offset, mapmode Mode);
648 /// \param fd An open file descriptor to map. mapped_file_region takes
649 /// ownership if closefd is true. It must have been opended in the correct
651 mapped_file_region(int fd, mapmode mode, uint64_t length, uint64_t offset,
652 std::error_code &ec);
654 ~mapped_file_region();
656 uint64_t size() const;
659 /// Get a const view of the data. Modifying this memory has undefined
661 const char *const_data() const;
663 /// \returns The minimum alignment offset must be.
664 static int alignment();
667 /// Return the path to the main executable, given the value of argv[0] from
668 /// program startup and the address of main itself. In extremis, this function
669 /// may fail and return an empty path.
670 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
676 /// directory_entry - A single entry in a directory. Caches the status either
677 /// from the result of the iteration syscall, or the first time status is
679 class directory_entry {
681 mutable file_status Status;
684 explicit directory_entry(const Twine &path, file_status st = file_status())
690 void assign(const Twine &path, file_status st = file_status()) {
695 void replace_filename(const Twine &filename, file_status st = file_status());
697 const std::string &path() const { return Path; }
698 std::error_code status(file_status &result) const;
700 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
701 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
702 bool operator< (const directory_entry& rhs) const;
703 bool operator<=(const directory_entry& rhs) const;
704 bool operator> (const directory_entry& rhs) const;
705 bool operator>=(const directory_entry& rhs) const;
711 std::error_code directory_iterator_construct(DirIterState &, StringRef);
712 std::error_code directory_iterator_increment(DirIterState &);
713 std::error_code directory_iterator_destruct(DirIterState &);
715 /// DirIterState - Keeps state for the directory_iterator. It is reference
716 /// counted in order to preserve InputIterator semantics on copy.
717 struct DirIterState : public RefCountedBase<DirIterState> {
719 : IterationHandle(0) {}
722 directory_iterator_destruct(*this);
725 intptr_t IterationHandle;
726 directory_entry CurrentEntry;
730 /// directory_iterator - Iterates through the entries in path. There is no
731 /// operator++ because we need an error_code. If it's really needed we can make
732 /// it call report_fatal_error on error.
733 class directory_iterator {
734 IntrusiveRefCntPtr<detail::DirIterState> State;
737 explicit directory_iterator(const Twine &path, std::error_code &ec) {
738 State = new detail::DirIterState;
739 SmallString<128> path_storage;
740 ec = detail::directory_iterator_construct(*State,
741 path.toStringRef(path_storage));
744 explicit directory_iterator(const directory_entry &de, std::error_code &ec) {
745 State = new detail::DirIterState;
746 ec = detail::directory_iterator_construct(*State, de.path());
749 /// Construct end iterator.
750 directory_iterator() : State(nullptr) {}
752 // No operator++ because we need error_code.
753 directory_iterator &increment(std::error_code &ec) {
754 ec = directory_iterator_increment(*State);
758 const directory_entry &operator*() const { return State->CurrentEntry; }
759 const directory_entry *operator->() const { return &State->CurrentEntry; }
761 bool operator==(const directory_iterator &RHS) const {
762 if (State == RHS.State)
765 return State->CurrentEntry == directory_entry();
767 return RHS.State->CurrentEntry == directory_entry();
768 return State->CurrentEntry == RHS.State->CurrentEntry;
771 bool operator!=(const directory_iterator &RHS) const {
772 return !(*this == RHS);
774 // Other members as required by
775 // C++ Std, 24.1.1 Input iterators [input.iterators]
779 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
780 /// reference counted in order to preserve InputIterator semantics on copy.
781 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
784 , HasNoPushRequest(false) {}
786 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
788 bool HasNoPushRequest;
792 /// recursive_directory_iterator - Same as directory_iterator except for it
793 /// recurses down into child directories.
794 class recursive_directory_iterator {
795 IntrusiveRefCntPtr<detail::RecDirIterState> State;
798 recursive_directory_iterator() {}
799 explicit recursive_directory_iterator(const Twine &path, std::error_code &ec)
800 : State(new detail::RecDirIterState) {
801 State->Stack.push(directory_iterator(path, ec));
802 if (State->Stack.top() == directory_iterator())
805 // No operator++ because we need error_code.
806 recursive_directory_iterator &increment(std::error_code &ec) {
807 const directory_iterator end_itr;
809 if (State->HasNoPushRequest)
810 State->HasNoPushRequest = false;
813 if ((ec = State->Stack.top()->status(st))) return *this;
814 if (is_directory(st)) {
815 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
816 if (ec) return *this;
817 if (State->Stack.top() != end_itr) {
825 while (!State->Stack.empty()
826 && State->Stack.top().increment(ec) == end_itr) {
831 // Check if we are done. If so, create an end iterator.
832 if (State->Stack.empty())
838 const directory_entry &operator*() const { return *State->Stack.top(); }
839 const directory_entry *operator->() const { return &*State->Stack.top(); }
842 /// Gets the current level. Starting path is at level 0.
843 int level() const { return State->Level; }
845 /// Returns true if no_push has been called for this directory_entry.
846 bool no_push_request() const { return State->HasNoPushRequest; }
849 /// Goes up one level if Level > 0.
851 assert(State && "Cannot pop an end iterator!");
852 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
854 const directory_iterator end_itr;
858 report_fatal_error("Error incrementing directory iterator.");
861 } while (!State->Stack.empty()
862 && State->Stack.top().increment(ec) == end_itr);
864 // Check if we are done. If so, create an end iterator.
865 if (State->Stack.empty())
869 /// Does not go down into the current directory_entry.
870 void no_push() { State->HasNoPushRequest = true; }
872 bool operator==(const recursive_directory_iterator &RHS) const {
873 return State == RHS.State;
876 bool operator!=(const recursive_directory_iterator &RHS) const {
877 return !(*this == RHS);
879 // Other members as required by
880 // C++ Std, 24.1.1 Input iterators [input.iterators]
885 } // end namespace fs
886 } // end namespace sys
887 } // end namespace llvm