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/Config/config.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/TimeValue.h"
41 #include <system_error>
45 #ifdef HAVE_SYS_STAT_H
53 /// An enumeration for the file system's view of the type.
54 enum class file_type {
67 /// space_info - Self explanatory.
79 owner_all = owner_read | owner_write | owner_exe,
83 group_all = group_read | group_write | group_exe,
87 others_all = others_read | others_write | others_exe,
88 all_read = owner_read | group_read | others_read,
89 all_write = owner_write | group_write | others_write,
90 all_exe = owner_exe | group_exe | others_exe,
91 all_all = owner_all | group_all | others_all,
92 set_uid_on_exe = 04000,
93 set_gid_on_exe = 02000,
95 perms_not_known = 0xFFFF
98 // Helper functions so that you can use & and | to manipulate perms bits:
99 inline perms operator|(perms l, perms r) {
100 return static_cast<perms>(static_cast<unsigned short>(l) |
101 static_cast<unsigned short>(r));
103 inline perms operator&(perms l, perms r) {
104 return static_cast<perms>(static_cast<unsigned short>(l) &
105 static_cast<unsigned short>(r));
107 inline perms &operator|=(perms &l, perms r) {
111 inline perms &operator&=(perms &l, perms r) {
115 inline perms operator~(perms x) {
116 return static_cast<perms>(~static_cast<unsigned short>(x));
124 UniqueID() = default;
125 UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
126 bool operator==(const UniqueID &Other) const {
127 return Device == Other.Device && File == Other.File;
129 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
130 bool operator<(const UniqueID &Other) const {
131 return std::tie(Device, File) < std::tie(Other.Device, Other.File);
133 uint64_t getDevice() const { return Device; }
134 uint64_t getFile() const { return File; }
137 /// file_status - Represents the result of a call to stat and friends. It has
138 /// a platform-specific member to store the result.
141 #if defined(LLVM_ON_UNIX)
148 #elif defined (LLVM_ON_WIN32)
149 uint32_t LastWriteTimeHigh;
150 uint32_t LastWriteTimeLow;
151 uint32_t VolumeSerialNumber;
152 uint32_t FileSizeHigh;
153 uint32_t FileSizeLow;
154 uint32_t FileIndexHigh;
155 uint32_t FileIndexLow;
157 friend bool equivalent(file_status A, file_status B);
162 #if defined(LLVM_ON_UNIX)
163 file_status() : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
164 fs_st_uid(0), fs_st_gid(0), fs_st_size(0),
165 Type(file_type::status_error), Perms(perms_not_known) {}
167 file_status(file_type Type) : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
168 fs_st_uid(0), fs_st_gid(0), fs_st_size(0), Type(Type),
169 Perms(perms_not_known) {}
171 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
172 uid_t UID, gid_t GID, off_t Size)
173 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
174 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
175 #elif defined(LLVM_ON_WIN32)
176 file_status() : LastWriteTimeHigh(0), LastWriteTimeLow(0),
177 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
178 FileIndexHigh(0), FileIndexLow(0), Type(file_type::status_error),
179 Perms(perms_not_known) {}
181 file_status(file_type Type) : LastWriteTimeHigh(0), LastWriteTimeLow(0),
182 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
183 FileIndexHigh(0), FileIndexLow(0), Type(Type),
184 Perms(perms_not_known) {}
186 file_status(file_type Type, uint32_t LastWriteTimeHigh,
187 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
188 uint32_t FileSizeHigh, uint32_t FileSizeLow,
189 uint32_t FileIndexHigh, uint32_t FileIndexLow)
190 : LastWriteTimeHigh(LastWriteTimeHigh),
191 LastWriteTimeLow(LastWriteTimeLow),
192 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
193 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
194 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
198 file_type type() const { return Type; }
199 perms permissions() const { return Perms; }
200 TimeValue getLastModificationTime() const;
201 UniqueID getUniqueID() const;
203 #if defined(LLVM_ON_UNIX)
204 uint32_t getUser() const { return fs_st_uid; }
205 uint32_t getGroup() const { return fs_st_gid; }
206 uint64_t getSize() const { return fs_st_size; }
207 #elif defined (LLVM_ON_WIN32)
208 uint32_t getUser() const {
209 return 9999; // Not applicable to Windows, so...
211 uint32_t getGroup() const {
212 return 9999; // Not applicable to Windows, so...
214 uint64_t getSize() const {
215 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
220 void type(file_type v) { Type = v; }
221 void permissions(perms p) { Perms = p; }
224 /// file_magic - An "enum class" enumeration of file types based on magic (the first
225 /// N bytes of the file).
228 unknown = 0, ///< Unrecognized file
229 bitcode, ///< Bitcode file
230 archive, ///< ar style archive file
231 elf, ///< ELF Unknown type
232 elf_relocatable, ///< ELF Relocatable object file
233 elf_executable, ///< ELF Executable image
234 elf_shared_object, ///< ELF dynamically linked shared lib
235 elf_core, ///< ELF core image
236 macho_object, ///< Mach-O Object file
237 macho_executable, ///< Mach-O Executable
238 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
239 macho_core, ///< Mach-O Core File
240 macho_preload_executable, ///< Mach-O Preloaded Executable
241 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
242 macho_dynamic_linker, ///< The Mach-O dynamic linker
243 macho_bundle, ///< Mach-O Bundle file
244 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
245 macho_dsym_companion, ///< Mach-O dSYM companion file
246 macho_kext_bundle, ///< Mach-O kext bundle file
247 macho_universal_binary, ///< Mach-O universal binary
248 coff_object, ///< COFF object file
249 coff_import_library, ///< COFF import library
250 pecoff_executable, ///< PECOFF executable file
251 windows_resource ///< Windows compiled resource file (.rc)
254 bool is_object() const {
255 return V == unknown ? false : true;
258 file_magic() : V(unknown) {}
259 file_magic(Impl V) : V(V) {}
260 operator Impl() const { return V; }
267 /// @name Physical Operators
270 /// @brief Make \a path an absolute path.
272 /// Makes \a path absolute using the \a current_directory if it is not already.
273 /// An empty \a path will result in the \a current_directory.
275 /// /absolute/path => /absolute/path
276 /// relative/../path => <current-directory>/relative/../path
278 /// @param path A path that is modified to be an absolute path.
279 /// @returns errc::success if \a path has been made absolute, otherwise a
280 /// platform-specific error_code.
281 std::error_code make_absolute(const Twine ¤t_directory,
282 SmallVectorImpl<char> &path);
284 /// @brief Make \a path an absolute path.
286 /// Makes \a path absolute using the current directory if it is not already. An
287 /// empty \a path will result in the current directory.
289 /// /absolute/path => /absolute/path
290 /// relative/../path => <current-directory>/relative/../path
292 /// @param path A path that is modified to be an absolute path.
293 /// @returns errc::success if \a path has been made absolute, otherwise a
294 /// platform-specific error_code.
295 std::error_code make_absolute(SmallVectorImpl<char> &path);
297 /// @brief Create all the non-existent directories in path.
299 /// @param path Directories to create.
300 /// @returns errc::success if is_directory(path), otherwise a platform
301 /// specific error_code. If IgnoreExisting is false, also returns
302 /// error if the directory already existed.
303 std::error_code create_directories(const Twine &path,
304 bool IgnoreExisting = true,
305 perms Perms = owner_all | group_all);
307 /// @brief Create the directory in path.
309 /// @param path Directory to create.
310 /// @returns errc::success if is_directory(path), otherwise a platform
311 /// specific error_code. If IgnoreExisting is false, also returns
312 /// error if the directory already existed.
313 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true,
314 perms Perms = owner_all | group_all);
316 /// @brief Create a link from \a from to \a to.
318 /// The link may be a soft or a hard link, depending on the platform. The caller
319 /// may not assume which one. Currently on windows it creates a hard link since
320 /// soft links require extra privileges. On unix, it creates a soft link since
321 /// hard links don't work on SMB file systems.
323 /// @param to The path to hard link to.
324 /// @param from The path to hard link from. This is created.
325 /// @returns errc::success if the link was created, otherwise a platform
326 /// specific error_code.
327 std::error_code create_link(const Twine &to, const Twine &from);
329 /// @brief Get the current path.
331 /// @param result Holds the current path on return.
332 /// @returns errc::success if the current path has been stored in result,
333 /// otherwise a platform-specific error_code.
334 std::error_code current_path(SmallVectorImpl<char> &result);
336 /// @brief Remove path. Equivalent to POSIX remove().
338 /// @param path Input path.
339 /// @returns errc::success if path has been removed or didn't exist, otherwise a
340 /// platform-specific error code. If IgnoreNonExisting is false, also
341 /// returns error if the file didn't exist.
342 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
344 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
346 /// @param from The path to rename from.
347 /// @param to The path to rename to. This is created.
348 std::error_code rename(const Twine &from, const Twine &to);
350 /// @brief Copy the contents of \a From to \a To.
352 /// @param From The path to copy from.
353 /// @param To The path to copy to. This is created.
354 std::error_code copy_file(const Twine &From, const Twine &To);
356 /// @brief Resize path to size. File is resized as if by POSIX truncate().
358 /// @param FD Input file descriptor.
359 /// @param Size Size to resize to.
360 /// @returns errc::success if \a path has been resized to \a size, otherwise a
361 /// platform-specific error_code.
362 std::error_code resize_file(int FD, uint64_t Size);
365 /// @name Physical Observers
368 /// @brief Does file exist?
370 /// @param status A file_status previously returned from stat.
371 /// @returns True if the file represented by status exists, false if it does
373 bool exists(file_status status);
375 enum class AccessMode { Exist, Write, Execute };
377 /// @brief Can the file be accessed?
379 /// @param Path Input path.
380 /// @returns errc::success if the path can be accessed, otherwise a
381 /// platform-specific error_code.
382 std::error_code access(const Twine &Path, AccessMode Mode);
384 /// @brief Does file exist?
386 /// @param Path Input path.
387 /// @returns True if it exists, false otherwise.
388 inline bool exists(const Twine &Path) {
389 return !access(Path, AccessMode::Exist);
392 /// @brief Can we execute this file?
394 /// @param Path Input path.
395 /// @returns True if we can execute it, false otherwise.
396 bool can_execute(const Twine &Path);
398 /// @brief Can we write this file?
400 /// @param Path Input path.
401 /// @returns True if we can write to it, false otherwise.
402 inline bool can_write(const Twine &Path) {
403 return !access(Path, AccessMode::Write);
406 /// @brief Do file_status's represent the same thing?
408 /// @param A Input file_status.
409 /// @param B Input file_status.
411 /// assert(status_known(A) || status_known(B));
413 /// @returns True if A and B both represent the same file system entity, false
415 bool equivalent(file_status A, file_status B);
417 /// @brief Do paths represent the same thing?
419 /// assert(status_known(A) || status_known(B));
421 /// @param A Input path A.
422 /// @param B Input path B.
423 /// @param result Set to true if stat(A) and stat(B) have the same device and
424 /// inode (or equivalent).
425 /// @returns errc::success if result has been successfully set, otherwise a
426 /// platform-specific error_code.
427 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
429 /// @brief Simpler version of equivalent for clients that don't need to
430 /// differentiate between an error and false.
431 inline bool equivalent(const Twine &A, const Twine &B) {
433 return !equivalent(A, B, result) && result;
436 /// @brief Does status represent a directory?
438 /// @param status A file_status previously returned from status.
439 /// @returns status.type() == file_type::directory_file.
440 bool is_directory(file_status status);
442 /// @brief Is path a directory?
444 /// @param path Input path.
445 /// @param result Set to true if \a path is a directory, false if it is not.
446 /// Undefined otherwise.
447 /// @returns errc::success if result has been successfully set, otherwise a
448 /// platform-specific error_code.
449 std::error_code is_directory(const Twine &path, bool &result);
451 /// @brief Simpler version of is_directory for clients that don't need to
452 /// differentiate between an error and false.
453 inline bool is_directory(const Twine &Path) {
455 return !is_directory(Path, Result) && Result;
458 /// @brief Does status represent a regular file?
460 /// @param status A file_status previously returned from status.
461 /// @returns status_known(status) && status.type() == file_type::regular_file.
462 bool is_regular_file(file_status status);
464 /// @brief Is path a regular file?
466 /// @param path Input path.
467 /// @param result Set to true if \a path is a regular file, false if it is not.
468 /// Undefined otherwise.
469 /// @returns errc::success if result has been successfully set, otherwise a
470 /// platform-specific error_code.
471 std::error_code is_regular_file(const Twine &path, bool &result);
473 /// @brief Simpler version of is_regular_file for clients that don't need to
474 /// differentiate between an error and false.
475 inline bool is_regular_file(const Twine &Path) {
477 if (is_regular_file(Path, Result))
482 /// @brief Does this status represent something that exists but is not a
483 /// directory, regular file, or symlink?
485 /// @param status A file_status previously returned from status.
486 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
487 bool is_other(file_status status);
489 /// @brief Is path something that exists but is not a directory,
490 /// regular file, or symlink?
492 /// @param path Input path.
493 /// @param result Set to true if \a path exists, but is not a directory, regular
494 /// file, or a symlink, false if it does not. Undefined otherwise.
495 /// @returns errc::success if result has been successfully set, otherwise a
496 /// platform-specific error_code.
497 std::error_code is_other(const Twine &path, bool &result);
499 /// @brief Get file status as if by POSIX stat().
501 /// @param path Input path.
502 /// @param result Set to the file status.
503 /// @returns errc::success if result has been successfully set, otherwise a
504 /// platform-specific error_code.
505 std::error_code status(const Twine &path, file_status &result);
507 /// @brief A version for when a file descriptor is already available.
508 std::error_code status(int FD, file_status &Result);
510 /// @brief Get file size.
512 /// @param Path Input path.
513 /// @param Result Set to the size of the file in \a Path.
514 /// @returns errc::success if result has been successfully set, otherwise a
515 /// platform-specific error_code.
516 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
518 std::error_code EC = status(Path, Status);
521 Result = Status.getSize();
522 return std::error_code();
525 /// @brief Set the file modification and access time.
527 /// @returns errc::success if the file times were successfully set, otherwise a
528 /// platform-specific error_code or errc::function_not_supported on
529 /// platforms where the functionality isn't available.
530 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
532 /// @brief Is status available?
534 /// @param s Input file status.
535 /// @returns True if status() != status_error.
536 bool status_known(file_status s);
538 /// @brief Is status available?
540 /// @param path Input path.
541 /// @param result Set to true if status() != status_error.
542 /// @returns errc::success if result has been successfully set, otherwise a
543 /// platform-specific error_code.
544 std::error_code status_known(const Twine &path, bool &result);
546 /// @brief Create a uniquely named file.
548 /// Generates a unique path suitable for a temporary file and then opens it as a
549 /// file. The name is based on \a model with '%' replaced by a random char in
550 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
551 /// directory will be prepended.
553 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
555 /// This is an atomic operation. Either the file is created and opened, or the
556 /// file system is left untouched.
558 /// The intendend use is for files that are to be kept, possibly after
559 /// renaming them. For example, when running 'clang -c foo.o', the file can
560 /// be first created as foo-abc123.o and then renamed.
562 /// @param Model Name to base unique path off of.
563 /// @param ResultFD Set to the opened file's file descriptor.
564 /// @param ResultPath Set to the opened file's absolute path.
565 /// @returns errc::success if Result{FD,Path} have been successfully set,
566 /// otherwise a platform-specific error_code.
567 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
568 SmallVectorImpl<char> &ResultPath,
569 unsigned Mode = all_read | all_write);
571 /// @brief Simpler version for clients that don't want an open file.
572 std::error_code createUniqueFile(const Twine &Model,
573 SmallVectorImpl<char> &ResultPath);
575 /// @brief Create a file in the system temporary directory.
577 /// The filename is of the form prefix-random_chars.suffix. Since the directory
578 /// is not know to the caller, Prefix and Suffix cannot have path separators.
579 /// The files are created with mode 0600.
581 /// This should be used for things like a temporary .s that is removed after
582 /// running the assembler.
583 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
585 SmallVectorImpl<char> &ResultPath);
587 /// @brief Simpler version for clients that don't want an open file.
588 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
589 SmallVectorImpl<char> &ResultPath);
591 std::error_code createUniqueDirectory(const Twine &Prefix,
592 SmallVectorImpl<char> &ResultPath);
594 enum OpenFlags : unsigned {
597 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
598 /// report an error if the file already exists.
601 /// F_Append - When opening a file, if it already exists append to the
602 /// existing file instead of returning an error. This may not be specified
606 /// The file should be opened in text mode on platforms that make this
610 /// Open the file for read and write.
614 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
615 return OpenFlags(unsigned(A) | unsigned(B));
618 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
623 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
624 OpenFlags Flags, unsigned Mode = 0666);
626 std::error_code openFileForRead(const Twine &Name, int &ResultFD);
628 /// @brief Identify the type of a binary file based on how magical it is.
629 file_magic identify_magic(StringRef magic);
631 /// @brief Get and identify \a path's type based on its content.
633 /// @param path Input path.
634 /// @param result Set to the type of file, or file_magic::unknown.
635 /// @returns errc::success if result has been successfully set, otherwise a
636 /// platform-specific error_code.
637 std::error_code identify_magic(const Twine &path, file_magic &result);
639 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
641 /// This class represents a memory mapped file. It is based on
642 /// boost::iostreams::mapped_file.
643 class mapped_file_region {
644 mapped_file_region() = delete;
645 mapped_file_region(mapped_file_region&) = delete;
646 mapped_file_region &operator =(mapped_file_region&) = delete;
650 readonly, ///< May only access map via const_data as read only.
651 readwrite, ///< May access map via data and modify it. Written to path.
652 priv ///< May modify via data, but changes are lost on destruction.
656 /// Platform-specific mapping state.
660 std::error_code init(int FD, uint64_t Offset, mapmode Mode);
663 /// \param fd An open file descriptor to map. mapped_file_region takes
664 /// ownership if closefd is true. It must have been opended in the correct
666 mapped_file_region(int fd, mapmode mode, uint64_t length, uint64_t offset,
667 std::error_code &ec);
669 ~mapped_file_region();
671 uint64_t size() const;
674 /// Get a const view of the data. Modifying this memory has undefined
676 const char *const_data() const;
678 /// \returns The minimum alignment offset must be.
679 static int alignment();
682 /// Return the path to the main executable, given the value of argv[0] from
683 /// program startup and the address of main itself. In extremis, this function
684 /// may fail and return an empty path.
685 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
691 /// directory_entry - A single entry in a directory. Caches the status either
692 /// from the result of the iteration syscall, or the first time status is
694 class directory_entry {
696 mutable file_status Status;
699 explicit directory_entry(const Twine &path, file_status st = file_status())
705 void assign(const Twine &path, file_status st = file_status()) {
710 void replace_filename(const Twine &filename, file_status st = file_status());
712 const std::string &path() const { return Path; }
713 std::error_code status(file_status &result) const;
715 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
716 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
717 bool operator< (const directory_entry& rhs) const;
718 bool operator<=(const directory_entry& rhs) const;
719 bool operator> (const directory_entry& rhs) const;
720 bool operator>=(const directory_entry& rhs) const;
726 std::error_code directory_iterator_construct(DirIterState &, StringRef);
727 std::error_code directory_iterator_increment(DirIterState &);
728 std::error_code directory_iterator_destruct(DirIterState &);
730 /// DirIterState - Keeps state for the directory_iterator. It is reference
731 /// counted in order to preserve InputIterator semantics on copy.
732 struct DirIterState : public RefCountedBase<DirIterState> {
734 : IterationHandle(0) {}
737 directory_iterator_destruct(*this);
740 intptr_t IterationHandle;
741 directory_entry CurrentEntry;
745 /// directory_iterator - Iterates through the entries in path. There is no
746 /// operator++ because we need an error_code. If it's really needed we can make
747 /// it call report_fatal_error on error.
748 class directory_iterator {
749 IntrusiveRefCntPtr<detail::DirIterState> State;
752 explicit directory_iterator(const Twine &path, std::error_code &ec) {
753 State = new detail::DirIterState;
754 SmallString<128> path_storage;
755 ec = detail::directory_iterator_construct(*State,
756 path.toStringRef(path_storage));
759 explicit directory_iterator(const directory_entry &de, std::error_code &ec) {
760 State = new detail::DirIterState;
761 ec = detail::directory_iterator_construct(*State, de.path());
764 /// Construct end iterator.
765 directory_iterator() : State(nullptr) {}
767 // No operator++ because we need error_code.
768 directory_iterator &increment(std::error_code &ec) {
769 ec = directory_iterator_increment(*State);
773 const directory_entry &operator*() const { return State->CurrentEntry; }
774 const directory_entry *operator->() const { return &State->CurrentEntry; }
776 bool operator==(const directory_iterator &RHS) const {
777 if (State == RHS.State)
780 return State->CurrentEntry == directory_entry();
782 return RHS.State->CurrentEntry == directory_entry();
783 return State->CurrentEntry == RHS.State->CurrentEntry;
786 bool operator!=(const directory_iterator &RHS) const {
787 return !(*this == RHS);
789 // Other members as required by
790 // C++ Std, 24.1.1 Input iterators [input.iterators]
794 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
795 /// reference counted in order to preserve InputIterator semantics on copy.
796 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
799 , HasNoPushRequest(false) {}
801 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
803 bool HasNoPushRequest;
807 /// recursive_directory_iterator - Same as directory_iterator except for it
808 /// recurses down into child directories.
809 class recursive_directory_iterator {
810 IntrusiveRefCntPtr<detail::RecDirIterState> State;
813 recursive_directory_iterator() {}
814 explicit recursive_directory_iterator(const Twine &path, std::error_code &ec)
815 : State(new detail::RecDirIterState) {
816 State->Stack.push(directory_iterator(path, ec));
817 if (State->Stack.top() == directory_iterator())
820 // No operator++ because we need error_code.
821 recursive_directory_iterator &increment(std::error_code &ec) {
822 const directory_iterator end_itr;
824 if (State->HasNoPushRequest)
825 State->HasNoPushRequest = false;
828 if ((ec = State->Stack.top()->status(st))) return *this;
829 if (is_directory(st)) {
830 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
831 if (ec) return *this;
832 if (State->Stack.top() != end_itr) {
840 while (!State->Stack.empty()
841 && State->Stack.top().increment(ec) == end_itr) {
846 // Check if we are done. If so, create an end iterator.
847 if (State->Stack.empty())
853 const directory_entry &operator*() const { return *State->Stack.top(); }
854 const directory_entry *operator->() const { return &*State->Stack.top(); }
857 /// Gets the current level. Starting path is at level 0.
858 int level() const { return State->Level; }
860 /// Returns true if no_push has been called for this directory_entry.
861 bool no_push_request() const { return State->HasNoPushRequest; }
864 /// Goes up one level if Level > 0.
866 assert(State && "Cannot pop an end iterator!");
867 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
869 const directory_iterator end_itr;
873 report_fatal_error("Error incrementing directory iterator.");
876 } while (!State->Stack.empty()
877 && State->Stack.top().increment(ec) == end_itr);
879 // Check if we are done. If so, create an end iterator.
880 if (State->Stack.empty())
884 /// Does not go down into the current directory_entry.
885 void no_push() { State->HasNoPushRequest = true; }
887 bool operator==(const recursive_directory_iterator &RHS) const {
888 return State == RHS.State;
891 bool operator!=(const recursive_directory_iterator &RHS) const {
892 return !(*this == RHS);
894 // Other members as required by
895 // C++ Std, 24.1.1 Input iterators [input.iterators]
900 } // end namespace fs
901 } // end namespace sys
902 } // end namespace llvm