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>(
100 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
102 inline perms operator&(perms l , perms r) {
103 return static_cast<perms>(
104 static_cast<unsigned short>(l) & 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));
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);
160 #if defined(LLVM_ON_UNIX)
161 file_status() : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
162 fs_st_uid(0), fs_st_gid(0), fs_st_size(0),
163 Type(file_type::status_error), Perms(perms_not_known) {}
165 file_status(file_type Type) : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
166 fs_st_uid(0), fs_st_gid(0), fs_st_size(0), Type(Type),
167 Perms(perms_not_known) {}
169 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
170 uid_t UID, gid_t GID, off_t Size)
171 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
172 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
173 #elif defined(LLVM_ON_WIN32)
174 file_status() : LastWriteTimeHigh(0), LastWriteTimeLow(0),
175 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
176 FileIndexHigh(0), FileIndexLow(0), Type(file_type::status_error),
177 Perms(perms_not_known) {}
179 file_status(file_type Type) : LastWriteTimeHigh(0), LastWriteTimeLow(0),
180 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
181 FileIndexHigh(0), FileIndexLow(0), Type(Type),
182 Perms(perms_not_known) {}
184 file_status(file_type Type, uint32_t LastWriteTimeHigh,
185 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
186 uint32_t FileSizeHigh, uint32_t FileSizeLow,
187 uint32_t FileIndexHigh, uint32_t FileIndexLow)
188 : LastWriteTimeHigh(LastWriteTimeHigh),
189 LastWriteTimeLow(LastWriteTimeLow),
190 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
191 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
192 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
196 file_type type() const { return Type; }
197 perms permissions() const { return Perms; }
198 TimeValue getLastModificationTime() const;
199 UniqueID getUniqueID() const;
201 #if defined(LLVM_ON_UNIX)
202 uint32_t getUser() const { return fs_st_uid; }
203 uint32_t getGroup() const { return fs_st_gid; }
204 uint64_t getSize() const { return fs_st_size; }
205 #elif defined (LLVM_ON_WIN32)
206 uint32_t getUser() const {
207 return 9999; // Not applicable to Windows, so...
209 uint32_t getGroup() const {
210 return 9999; // Not applicable to Windows, so...
212 uint64_t getSize() const {
213 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
218 void type(file_type v) { Type = v; }
219 void permissions(perms p) { Perms = p; }
222 /// file_magic - An "enum class" enumeration of file types based on magic (the first
223 /// N bytes of the file).
226 unknown = 0, ///< Unrecognized file
227 bitcode, ///< Bitcode file
228 archive, ///< ar style archive file
229 elf_relocatable, ///< ELF Relocatable object file
230 elf_executable, ///< ELF Executable image
231 elf_shared_object, ///< ELF dynamically linked shared lib
232 elf_core, ///< ELF core image
233 macho_object, ///< Mach-O Object file
234 macho_executable, ///< Mach-O Executable
235 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
236 macho_core, ///< Mach-O Core File
237 macho_preload_executable, ///< Mach-O Preloaded Executable
238 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
239 macho_dynamic_linker, ///< The Mach-O dynamic linker
240 macho_bundle, ///< Mach-O Bundle file
241 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
242 macho_dsym_companion, ///< Mach-O dSYM companion file
243 macho_universal_binary, ///< Mach-O universal binary
244 coff_object, ///< COFF object file
245 coff_import_library, ///< COFF import library
246 pecoff_executable, ///< PECOFF executable file
247 windows_resource ///< Windows compiled resource file (.rc)
250 bool is_object() const {
251 return V == unknown ? false : true;
254 file_magic() : V(unknown) {}
255 file_magic(Impl V) : V(V) {}
256 operator Impl() const { return V; }
263 /// @name Physical Operators
266 /// @brief Make \a path an absolute path.
268 /// Makes \a path absolute using the current directory if it is not already. An
269 /// empty \a path will result in the current directory.
271 /// /absolute/path => /absolute/path
272 /// relative/../path => <current-directory>/relative/../path
274 /// @param path A path that is modified to be an absolute path.
275 /// @returns errc::success if \a path has been made absolute, otherwise a
276 /// platform-specific error_code.
277 std::error_code make_absolute(SmallVectorImpl<char> &path);
279 /// @brief Create all the non-existent directories in path.
281 /// @param path Directories to create.
282 /// @returns errc::success if is_directory(path), otherwise a platform
283 /// specific error_code. If IgnoreExisting is false, also returns
284 /// error if the directory already existed.
285 std::error_code create_directories(const Twine &path,
286 bool IgnoreExisting = true);
288 /// @brief Create the directory in path.
290 /// @param path Directory to create.
291 /// @returns errc::success if is_directory(path), otherwise a platform
292 /// specific error_code. If IgnoreExisting is false, also returns
293 /// error if the directory already existed.
294 std::error_code create_directory(const Twine &path, bool IgnoreExisting = true);
296 /// @brief Create a link from \a from to \a to.
298 /// The link may be a soft or a hard link, depending on the platform. The caller
299 /// may not assume which one. Currently on windows it creates a hard link since
300 /// soft links require extra privileges. On unix, it creates a soft link since
301 /// hard links don't work on SMB file systems.
303 /// @param to The path to hard link to.
304 /// @param from The path to hard link from. This is created.
305 /// @returns errc::success if the link was created, otherwise a platform
306 /// specific error_code.
307 std::error_code create_link(const Twine &to, const Twine &from);
309 /// @brief Get the current path.
311 /// @param result Holds the current path on return.
312 /// @returns errc::success if the current path has been stored in result,
313 /// otherwise a platform-specific error_code.
314 std::error_code current_path(SmallVectorImpl<char> &result);
316 /// @brief Remove path. Equivalent to POSIX remove().
318 /// @param path Input path.
319 /// @returns errc::success if path has been removed or didn't exist, otherwise a
320 /// platform-specific error code. If IgnoreNonExisting is false, also
321 /// returns error if the file didn't exist.
322 std::error_code remove(const Twine &path, bool IgnoreNonExisting = true);
324 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
326 /// @param from The path to rename from.
327 /// @param to The path to rename to. This is created.
328 std::error_code rename(const Twine &from, const Twine &to);
330 /// @brief Copy the contents of \a From to \a To.
332 /// @param From The path to copy from.
333 /// @param To The path to copy to. This is created.
334 std::error_code copy_file(const Twine &From, const Twine &To);
336 /// @brief Resize path to size. File is resized as if by POSIX truncate().
338 /// @param path Input path.
339 /// @param size Size to resize to.
340 /// @returns errc::success if \a path has been resized to \a size, otherwise a
341 /// platform-specific error_code.
342 std::error_code resize_file(const Twine &path, uint64_t size);
345 /// @name Physical Observers
348 /// @brief Does file exist?
350 /// @param status A file_status previously returned from stat.
351 /// @returns True if the file represented by status exists, false if it does
353 bool exists(file_status status);
355 enum class AccessMode { Exist, Write, Execute };
357 /// @brief Can the file be accessed?
359 /// @param Path Input path.
360 /// @returns errc::success if the path can be accessed, otherwise a
361 /// platform-specific error_code.
362 std::error_code access(const Twine &Path, AccessMode Mode);
364 /// @brief Does file exist?
366 /// @param Path Input path.
367 /// @returns True if it exists, false otherwise.
368 inline bool exists(const Twine &Path) {
369 return !access(Path, AccessMode::Exist);
372 /// @brief Can we execute this file?
374 /// @param Path Input path.
375 /// @returns True if we can execute it, false otherwise.
376 inline bool can_execute(const Twine &Path) {
377 return !access(Path, AccessMode::Execute);
380 /// @brief Can we write this file?
382 /// @param Path Input path.
383 /// @returns True if we can write to it, false otherwise.
384 inline bool can_write(const Twine &Path) {
385 return !access(Path, AccessMode::Write);
388 /// @brief Do file_status's represent the same thing?
390 /// @param A Input file_status.
391 /// @param B Input file_status.
393 /// assert(status_known(A) || status_known(B));
395 /// @returns True if A and B both represent the same file system entity, false
397 bool equivalent(file_status A, file_status B);
399 /// @brief Do paths represent the same thing?
401 /// assert(status_known(A) || status_known(B));
403 /// @param A Input path A.
404 /// @param B Input path B.
405 /// @param result Set to true if stat(A) and stat(B) have the same device and
406 /// inode (or equivalent).
407 /// @returns errc::success if result has been successfully set, otherwise a
408 /// platform-specific error_code.
409 std::error_code equivalent(const Twine &A, const Twine &B, bool &result);
411 /// @brief Simpler version of equivalent for clients that don't need to
412 /// differentiate between an error and false.
413 inline bool equivalent(const Twine &A, const Twine &B) {
415 return !equivalent(A, B, result) && result;
418 /// @brief Does status represent a directory?
420 /// @param status A file_status previously returned from status.
421 /// @returns status.type() == file_type::directory_file.
422 bool is_directory(file_status status);
424 /// @brief Is path a directory?
426 /// @param path Input path.
427 /// @param result Set to true if \a path is a directory, false if it is not.
428 /// Undefined otherwise.
429 /// @returns errc::success if result has been successfully set, otherwise a
430 /// platform-specific error_code.
431 std::error_code is_directory(const Twine &path, bool &result);
433 /// @brief Simpler version of is_directory for clients that don't need to
434 /// differentiate between an error and false.
435 inline bool is_directory(const Twine &Path) {
437 return !is_directory(Path, Result) && Result;
440 /// @brief Does status represent a regular file?
442 /// @param status A file_status previously returned from status.
443 /// @returns status_known(status) && status.type() == file_type::regular_file.
444 bool is_regular_file(file_status status);
446 /// @brief Is path a regular file?
448 /// @param path Input path.
449 /// @param result Set to true if \a path is a regular file, false if it is not.
450 /// Undefined otherwise.
451 /// @returns errc::success if result has been successfully set, otherwise a
452 /// platform-specific error_code.
453 std::error_code is_regular_file(const Twine &path, bool &result);
455 /// @brief Simpler version of is_regular_file for clients that don't need to
456 /// differentiate between an error and false.
457 inline bool is_regular_file(const Twine &Path) {
459 if (is_regular_file(Path, Result))
464 /// @brief Does this status represent something that exists but is not a
465 /// directory, regular file, or symlink?
467 /// @param status A file_status previously returned from status.
468 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
469 bool is_other(file_status status);
471 /// @brief Is path something that exists but is not a directory,
472 /// regular file, or symlink?
474 /// @param path Input path.
475 /// @param result Set to true if \a path exists, but is not a directory, regular
476 /// file, or a symlink, false if it does not. Undefined otherwise.
477 /// @returns errc::success if result has been successfully set, otherwise a
478 /// platform-specific error_code.
479 std::error_code is_other(const Twine &path, bool &result);
481 /// @brief Get file status as if by POSIX stat().
483 /// @param path Input path.
484 /// @param result Set to the file status.
485 /// @returns errc::success if result has been successfully set, otherwise a
486 /// platform-specific error_code.
487 std::error_code status(const Twine &path, file_status &result);
489 /// @brief A version for when a file descriptor is already available.
490 std::error_code status(int FD, file_status &Result);
492 /// @brief Get file size.
494 /// @param Path Input path.
495 /// @param Result Set to the size of the file in \a Path.
496 /// @returns errc::success if result has been successfully set, otherwise a
497 /// platform-specific error_code.
498 inline std::error_code file_size(const Twine &Path, uint64_t &Result) {
500 std::error_code EC = status(Path, Status);
503 Result = Status.getSize();
504 return std::error_code();
507 /// @brief Set the file modification and access time.
509 /// @returns errc::success if the file times were successfully set, otherwise a
510 /// platform-specific error_code or errc::function_not_supported on
511 /// platforms where the functionality isn't available.
512 std::error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
514 /// @brief Is status available?
516 /// @param s Input file status.
517 /// @returns True if status() != status_error.
518 bool status_known(file_status s);
520 /// @brief Is status available?
522 /// @param path Input path.
523 /// @param result Set to true if status() != status_error.
524 /// @returns errc::success if result has been successfully set, otherwise a
525 /// platform-specific error_code.
526 std::error_code status_known(const Twine &path, bool &result);
528 /// @brief Create a uniquely named file.
530 /// Generates a unique path suitable for a temporary file and then opens it as a
531 /// file. The name is based on \a model with '%' replaced by a random char in
532 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
533 /// directory will be prepended.
535 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
537 /// This is an atomic operation. Either the file is created and opened, or the
538 /// file system is left untouched.
540 /// The intendend use is for files that are to be kept, possibly after
541 /// renaming them. For example, when running 'clang -c foo.o', the file can
542 /// be first created as foo-abc123.o and then renamed.
544 /// @param Model Name to base unique path off of.
545 /// @param ResultFD Set to the opened file's file descriptor.
546 /// @param ResultPath Set to the opened file's absolute path.
547 /// @returns errc::success if Result{FD,Path} have been successfully set,
548 /// otherwise a platform-specific error_code.
549 std::error_code createUniqueFile(const Twine &Model, int &ResultFD,
550 SmallVectorImpl<char> &ResultPath,
551 unsigned Mode = all_read | all_write);
553 /// @brief Simpler version for clients that don't want an open file.
554 std::error_code createUniqueFile(const Twine &Model,
555 SmallVectorImpl<char> &ResultPath);
557 /// @brief Create a file in the system temporary directory.
559 /// The filename is of the form prefix-random_chars.suffix. Since the directory
560 /// is not know to the caller, Prefix and Suffix cannot have path separators.
561 /// The files are created with mode 0600.
563 /// This should be used for things like a temporary .s that is removed after
564 /// running the assembler.
565 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
567 SmallVectorImpl<char> &ResultPath);
569 /// @brief Simpler version for clients that don't want an open file.
570 std::error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
571 SmallVectorImpl<char> &ResultPath);
573 std::error_code createUniqueDirectory(const Twine &Prefix,
574 SmallVectorImpl<char> &ResultPath);
576 enum OpenFlags : unsigned {
579 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
580 /// report an error if the file already exists.
583 /// F_Append - When opening a file, if it already exists append to the
584 /// existing file instead of returning an error. This may not be specified
588 /// The file should be opened in text mode on platforms that make this
592 /// Open the file for read and write.
596 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
597 return OpenFlags(unsigned(A) | unsigned(B));
600 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
605 std::error_code openFileForWrite(const Twine &Name, int &ResultFD,
606 OpenFlags Flags, unsigned Mode = 0666);
608 std::error_code openFileForRead(const Twine &Name, int &ResultFD);
610 /// @brief Identify the type of a binary file based on how magical it is.
611 file_magic identify_magic(StringRef magic);
613 /// @brief Get and identify \a path's type based on its content.
615 /// @param path Input path.
616 /// @param result Set to the type of file, or file_magic::unknown.
617 /// @returns errc::success if result has been successfully set, otherwise a
618 /// platform-specific error_code.
619 std::error_code identify_magic(const Twine &path, file_magic &result);
621 std::error_code getUniqueID(const Twine Path, UniqueID &Result);
623 /// This class represents a memory mapped file. It is based on
624 /// boost::iostreams::mapped_file.
625 class mapped_file_region {
626 mapped_file_region() LLVM_DELETED_FUNCTION;
627 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
628 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
632 readonly, ///< May only access map via const_data as read only.
633 readwrite, ///< May access map via data and modify it. Written to path.
634 priv ///< May modify via data, but changes are lost on destruction.
638 /// Platform-specific mapping state.
645 void *FileMappingHandle;
648 std::error_code init(int FD, bool CloseFD, uint64_t Offset);
651 typedef char char_type;
653 mapped_file_region(mapped_file_region&&);
654 mapped_file_region &operator =(mapped_file_region&&);
656 /// Construct a mapped_file_region at \a path starting at \a offset of length
657 /// \a length and with access \a mode.
659 /// \param path Path to the file to map. If it does not exist it will be
661 /// \param mode How to map the memory.
662 /// \param length Number of bytes to map in starting at \a offset. If the file
663 /// is shorter than this, it will be extended. If \a length is
664 /// 0, the entire file will be mapped.
665 /// \param offset Byte offset from the beginning of the file where the map
666 /// should begin. Must be a multiple of
667 /// mapped_file_region::alignment().
668 /// \param ec This is set to errc::success if the map was constructed
669 /// successfully. Otherwise it is set to a platform dependent error.
670 mapped_file_region(const Twine &path, mapmode mode, uint64_t length,
671 uint64_t offset, std::error_code &ec);
673 /// \param fd An open file descriptor to map. mapped_file_region takes
674 /// ownership if closefd is true. It must have been opended in the correct
676 mapped_file_region(int fd, bool closefd, mapmode mode, uint64_t length,
677 uint64_t offset, std::error_code &ec);
679 ~mapped_file_region();
681 mapmode flags() const;
682 uint64_t size() const;
685 /// Get a const view of the data. Modifying this memory has undefined
687 const char *const_data() const;
689 /// \returns The minimum alignment offset must be.
690 static int alignment();
693 /// Return the path to the main executable, given the value of argv[0] from
694 /// program startup and the address of main itself. In extremis, this function
695 /// may fail and return an empty path.
696 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
702 /// directory_entry - A single entry in a directory. Caches the status either
703 /// from the result of the iteration syscall, or the first time status is
705 class directory_entry {
707 mutable file_status Status;
710 explicit directory_entry(const Twine &path, file_status st = file_status())
716 void assign(const Twine &path, file_status st = file_status()) {
721 void replace_filename(const Twine &filename, file_status st = file_status());
723 const std::string &path() const { return Path; }
724 std::error_code status(file_status &result) const;
726 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
727 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
728 bool operator< (const directory_entry& rhs) const;
729 bool operator<=(const directory_entry& rhs) const;
730 bool operator> (const directory_entry& rhs) const;
731 bool operator>=(const directory_entry& rhs) const;
737 std::error_code directory_iterator_construct(DirIterState &, StringRef);
738 std::error_code directory_iterator_increment(DirIterState &);
739 std::error_code directory_iterator_destruct(DirIterState &);
741 /// DirIterState - Keeps state for the directory_iterator. It is reference
742 /// counted in order to preserve InputIterator semantics on copy.
743 struct DirIterState : public RefCountedBase<DirIterState> {
745 : IterationHandle(0) {}
748 directory_iterator_destruct(*this);
751 intptr_t IterationHandle;
752 directory_entry CurrentEntry;
756 /// directory_iterator - Iterates through the entries in path. There is no
757 /// operator++ because we need an error_code. If it's really needed we can make
758 /// it call report_fatal_error on error.
759 class directory_iterator {
760 IntrusiveRefCntPtr<detail::DirIterState> State;
763 explicit directory_iterator(const Twine &path, std::error_code &ec) {
764 State = new detail::DirIterState;
765 SmallString<128> path_storage;
766 ec = detail::directory_iterator_construct(*State,
767 path.toStringRef(path_storage));
770 explicit directory_iterator(const directory_entry &de, std::error_code &ec) {
771 State = new detail::DirIterState;
772 ec = detail::directory_iterator_construct(*State, de.path());
775 /// Construct end iterator.
776 directory_iterator() : State(nullptr) {}
778 // No operator++ because we need error_code.
779 directory_iterator &increment(std::error_code &ec) {
780 ec = directory_iterator_increment(*State);
784 const directory_entry &operator*() const { return State->CurrentEntry; }
785 const directory_entry *operator->() const { return &State->CurrentEntry; }
787 bool operator==(const directory_iterator &RHS) const {
788 if (State == RHS.State)
791 return State->CurrentEntry == directory_entry();
793 return RHS.State->CurrentEntry == directory_entry();
794 return State->CurrentEntry == RHS.State->CurrentEntry;
797 bool operator!=(const directory_iterator &RHS) const {
798 return !(*this == RHS);
800 // Other members as required by
801 // C++ Std, 24.1.1 Input iterators [input.iterators]
805 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
806 /// reference counted in order to preserve InputIterator semantics on copy.
807 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
810 , HasNoPushRequest(false) {}
812 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
814 bool HasNoPushRequest;
818 /// recursive_directory_iterator - Same as directory_iterator except for it
819 /// recurses down into child directories.
820 class recursive_directory_iterator {
821 IntrusiveRefCntPtr<detail::RecDirIterState> State;
824 recursive_directory_iterator() {}
825 explicit recursive_directory_iterator(const Twine &path, std::error_code &ec)
826 : State(new detail::RecDirIterState) {
827 State->Stack.push(directory_iterator(path, ec));
828 if (State->Stack.top() == directory_iterator())
831 // No operator++ because we need error_code.
832 recursive_directory_iterator &increment(std::error_code &ec) {
833 const directory_iterator end_itr;
835 if (State->HasNoPushRequest)
836 State->HasNoPushRequest = false;
839 if ((ec = State->Stack.top()->status(st))) return *this;
840 if (is_directory(st)) {
841 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
842 if (ec) return *this;
843 if (State->Stack.top() != end_itr) {
851 while (!State->Stack.empty()
852 && State->Stack.top().increment(ec) == end_itr) {
857 // Check if we are done. If so, create an end iterator.
858 if (State->Stack.empty())
864 const directory_entry &operator*() const { return *State->Stack.top(); }
865 const directory_entry *operator->() const { return &*State->Stack.top(); }
868 /// Gets the current level. Starting path is at level 0.
869 int level() const { return State->Level; }
871 /// Returns true if no_push has been called for this directory_entry.
872 bool no_push_request() const { return State->HasNoPushRequest; }
875 /// Goes up one level if Level > 0.
877 assert(State && "Cannot pop an end iterator!");
878 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
880 const directory_iterator end_itr;
884 report_fatal_error("Error incrementing directory iterator.");
887 } while (!State->Stack.empty()
888 && State->Stack.top().increment(ec) == end_itr);
890 // Check if we are done. If so, create an end iterator.
891 if (State->Stack.empty())
895 /// Does not go down into the current directory_entry.
896 void no_push() { State->HasNoPushRequest = true; }
898 bool operator==(const recursive_directory_iterator &RHS) const {
899 return State == RHS.State;
902 bool operator!=(const recursive_directory_iterator &RHS) const {
903 return !(*this == RHS);
905 // Other members as required by
906 // C++ Std, 24.1.1 Input iterators [input.iterators]
911 } // end namespace fs
912 } // end namespace sys
913 } // end namespace llvm