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"
36 #include "llvm/Support/system_error.h"
44 #ifdef HAVE_SYS_STAT_H
52 /// An "enum class" enumeration for the file system's view of the type.
67 file_type(Impl V) : V(V) {}
68 operator Impl() const { return V; }
74 /// space_info - Self explanatory.
86 owner_all = owner_read | owner_write | owner_exe,
90 group_all = group_read | group_write | group_exe,
94 others_all = others_read | others_write | others_exe,
95 all_read = owner_read | group_read | others_read,
96 all_write = owner_write | group_write | others_write,
97 all_exe = owner_exe | group_exe | others_exe,
98 all_all = owner_all | group_all | others_all,
99 set_uid_on_exe = 04000,
100 set_gid_on_exe = 02000,
102 perms_not_known = 0xFFFF
105 // Helper functions so that you can use & and | to manipulate perms bits:
106 inline perms operator|(perms l , perms r) {
107 return static_cast<perms>(
108 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
110 inline perms operator&(perms l , perms r) {
111 return static_cast<perms>(
112 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
114 inline perms &operator|=(perms &l, perms r) {
118 inline perms &operator&=(perms &l, perms r) {
122 inline perms operator~(perms x) {
123 return static_cast<perms>(~static_cast<unsigned short>(x));
132 UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
133 bool operator==(const UniqueID &Other) const {
134 return Device == Other.Device && File == Other.File;
136 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
137 bool operator<(const UniqueID &Other) const {
138 return std::tie(Device, File) < std::tie(Other.Device, Other.File);
140 uint64_t getDevice() const { return Device; }
141 uint64_t getFile() const { return File; }
144 /// file_status - Represents the result of a call to stat and friends. It has
145 /// a platform specific member to store the result.
148 #if defined(LLVM_ON_UNIX)
155 #elif defined (LLVM_ON_WIN32)
156 uint32_t LastWriteTimeHigh;
157 uint32_t LastWriteTimeLow;
158 uint32_t VolumeSerialNumber;
159 uint32_t FileSizeHigh;
160 uint32_t FileSizeLow;
161 uint32_t FileIndexHigh;
162 uint32_t FileIndexLow;
164 friend bool equivalent(file_status A, file_status B);
168 file_status() : Type(file_type::status_error) {}
169 file_status(file_type Type) : Type(Type) {}
171 #if defined(LLVM_ON_UNIX)
172 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
173 uid_t UID, gid_t GID, off_t Size)
174 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
175 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
176 #elif defined(LLVM_ON_WIN32)
177 file_status(file_type Type, uint32_t LastWriteTimeHigh,
178 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
179 uint32_t FileSizeHigh, uint32_t FileSizeLow,
180 uint32_t FileIndexHigh, uint32_t FileIndexLow)
181 : LastWriteTimeHigh(LastWriteTimeHigh),
182 LastWriteTimeLow(LastWriteTimeLow),
183 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
184 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
185 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
189 file_type type() const { return Type; }
190 perms permissions() const { return Perms; }
191 TimeValue getLastModificationTime() const;
192 UniqueID getUniqueID() const;
194 #if defined(LLVM_ON_UNIX)
195 uint32_t getUser() const { return fs_st_uid; }
196 uint32_t getGroup() const { return fs_st_gid; }
197 uint64_t getSize() const { return fs_st_size; }
198 #elif defined (LLVM_ON_WIN32)
199 uint32_t getUser() const {
200 return 9999; // Not applicable to Windows, so...
202 uint32_t getGroup() const {
203 return 9999; // Not applicable to Windows, so...
205 uint64_t getSize() const {
206 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
211 void type(file_type v) { Type = v; }
212 void permissions(perms p) { Perms = p; }
215 /// file_magic - An "enum class" enumeration of file types based on magic (the first
216 /// N bytes of the file).
219 unknown = 0, ///< Unrecognized file
220 bitcode, ///< Bitcode file
221 archive, ///< ar style archive file
222 elf_relocatable, ///< ELF Relocatable object file
223 elf_executable, ///< ELF Executable image
224 elf_shared_object, ///< ELF dynamically linked shared lib
225 elf_core, ///< ELF core image
226 macho_object, ///< Mach-O Object file
227 macho_executable, ///< Mach-O Executable
228 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
229 macho_core, ///< Mach-O Core File
230 macho_preload_executable, ///< Mach-O Preloaded Executable
231 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
232 macho_dynamic_linker, ///< The Mach-O dynamic linker
233 macho_bundle, ///< Mach-O Bundle file
234 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
235 macho_dsym_companion, ///< Mach-O dSYM companion file
236 macho_universal_binary, ///< Mach-O universal binary
237 coff_object, ///< COFF object file
238 coff_import_library, ///< COFF import library
239 pecoff_executable, ///< PECOFF executable file
240 windows_resource ///< Windows compiled resource file (.rc)
243 bool is_object() const {
244 return V == unknown ? false : true;
247 file_magic() : V(unknown) {}
248 file_magic(Impl V) : V(V) {}
249 operator Impl() const { return V; }
256 /// @name Physical Operators
259 /// @brief Make \a path an absolute path.
261 /// Makes \a path absolute using the current directory if it is not already. An
262 /// empty \a path will result in the current directory.
264 /// /absolute/path => /absolute/path
265 /// relative/../path => <current-directory>/relative/../path
267 /// @param path A path that is modified to be an absolute path.
268 /// @returns errc::success if \a path has been made absolute, otherwise a
269 /// platform specific error_code.
270 error_code make_absolute(SmallVectorImpl<char> &path);
272 /// @brief Create all the non-existent directories in path.
274 /// @param path Directories to create.
275 /// @returns errc::success if is_directory(path), otherwise a platform
276 /// specific error_code. If IgnoreExisting is false, also returns
277 /// error if the directory already existed.
278 error_code create_directories(const Twine &path, bool IgnoreExisting = true);
280 /// @brief Create the directory in path.
282 /// @param path Directory to create.
283 /// @returns errc::success if is_directory(path), otherwise a platform
284 /// specific error_code. If IgnoreExisting is false, also returns
285 /// error if the directory already existed.
286 error_code create_directory(const Twine &path, bool IgnoreExisting = true);
288 /// @brief Create a hard link from \a from to \a to.
290 /// @param to The path to hard link to.
291 /// @param from The path to hard link from. This is created.
292 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
293 /// , otherwise a platform specific error_code.
294 error_code create_hard_link(const Twine &to, const Twine &from);
296 /// @brief Create a symbolic link from \a from to \a to.
298 /// @param to The path to link to.
299 /// @param from The path to link from. This is created.
300 /// @returns errc::success if successful
301 /// , otherwise a platform specific error_code.
302 error_code create_symbolic_link(const Twine &to, const Twine &from);
304 /// @brief Get the current path.
306 /// @param result Holds the current path on return.
307 /// @returns errc::success if the current path has been stored in result,
308 /// otherwise a platform specific error_code.
309 error_code current_path(SmallVectorImpl<char> &result);
311 /// @brief Remove path. Equivalent to POSIX remove().
313 /// @param path Input path.
314 /// @returns errc::success if path has been removed or didn't exist, otherwise a
315 /// platform specific error code. If IgnoreNonExisting is false, also
316 /// returns error if the file didn't exist.
317 error_code remove(const Twine &path, bool IgnoreNonExisting = true);
319 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
321 /// @param from The path to rename from.
322 /// @param to The path to rename to. This is created.
323 error_code rename(const Twine &from, const Twine &to);
325 /// @brief Resize path to size. File is resized as if by POSIX truncate().
327 /// @param path Input path.
328 /// @param size Size to resize to.
329 /// @returns errc::success if \a path has been resized to \a size, otherwise a
330 /// platform specific error_code.
331 error_code resize_file(const Twine &path, uint64_t size);
334 /// @name Physical Observers
337 /// @brief Does file exist?
339 /// @param status A file_status previously returned from stat.
340 /// @returns True if the file represented by status exists, false if it does
342 bool exists(file_status status);
344 /// @brief Does file exist?
346 /// @param path Input path.
347 /// @param result Set to true if the file represented by status exists, false if
348 /// it does not. Undefined otherwise.
349 /// @returns errc::success if result has been successfully set, otherwise a
350 /// platform specific error_code.
351 error_code exists(const Twine &path, bool &result);
353 /// @brief Simpler version of exists for clients that don't need to
354 /// differentiate between an error and false.
355 inline bool exists(const Twine &path) {
357 return !exists(path, result) && result;
360 /// @brief Can we execute this file?
362 /// @param Path Input path.
363 /// @returns True if we can execute it, false otherwise.
364 bool can_execute(const Twine &Path);
366 /// @brief Can we write this file?
368 /// @param Path Input path.
369 /// @returns True if we can write to it, false otherwise.
370 bool can_write(const Twine &Path);
372 /// @brief Do file_status's represent the same thing?
374 /// @param A Input file_status.
375 /// @param B Input file_status.
377 /// assert(status_known(A) || status_known(B));
379 /// @returns True if A and B both represent the same file system entity, false
381 bool equivalent(file_status A, file_status B);
383 /// @brief Do paths represent the same thing?
385 /// assert(status_known(A) || status_known(B));
387 /// @param A Input path A.
388 /// @param B Input path B.
389 /// @param result Set to true if stat(A) and stat(B) have the same device and
390 /// inode (or equivalent).
391 /// @returns errc::success if result has been successfully set, otherwise a
392 /// platform specific error_code.
393 error_code equivalent(const Twine &A, const Twine &B, bool &result);
395 /// @brief Simpler version of equivalent for clients that don't need to
396 /// differentiate between an error and false.
397 inline bool equivalent(const Twine &A, const Twine &B) {
399 return !equivalent(A, B, result) && result;
402 /// @brief Does status represent a directory?
404 /// @param status A file_status previously returned from status.
405 /// @returns status.type() == file_type::directory_file.
406 bool is_directory(file_status status);
408 /// @brief Is path a directory?
410 /// @param path Input path.
411 /// @param result Set to true if \a path is a directory, false if it is not.
412 /// Undefined otherwise.
413 /// @returns errc::success if result has been successfully set, otherwise a
414 /// platform specific error_code.
415 error_code is_directory(const Twine &path, bool &result);
417 /// @brief Simpler version of is_directory for clients that don't need to
418 /// differentiate between an error and false.
419 inline bool is_directory(const Twine &Path) {
421 return !is_directory(Path, Result) && Result;
424 /// @brief Does status represent a regular file?
426 /// @param status A file_status previously returned from status.
427 /// @returns status_known(status) && status.type() == file_type::regular_file.
428 bool is_regular_file(file_status status);
430 /// @brief Is path a regular file?
432 /// @param path Input path.
433 /// @param result Set to true if \a path is a regular file, false if it is not.
434 /// Undefined otherwise.
435 /// @returns errc::success if result has been successfully set, otherwise a
436 /// platform specific error_code.
437 error_code is_regular_file(const Twine &path, bool &result);
439 /// @brief Simpler version of is_regular_file for clients that don't need to
440 /// differentiate between an error and false.
441 inline bool is_regular_file(const Twine &Path) {
443 if (is_regular_file(Path, Result))
448 /// @brief Does this status represent something that exists but is not a
449 /// directory, regular file, or symlink?
451 /// @param status A file_status previously returned from status.
452 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
454 bool is_other(file_status status);
456 /// @brief Is path something that exists but is not a directory,
457 /// regular file, or symlink?
459 /// @param path Input path.
460 /// @param result Set to true if \a path exists, but is not a directory, regular
461 /// file, or a symlink, false if it does not. Undefined otherwise.
462 /// @returns errc::success if result has been successfully set, otherwise a
463 /// platform specific error_code.
464 error_code is_other(const Twine &path, bool &result);
466 /// @brief Does status represent a symlink?
468 /// @param status A file_status previously returned from stat.
469 /// @returns status.type() == symlink_file.
470 bool is_symlink(file_status status);
472 /// @brief Is path a symlink?
474 /// @param path Input path.
475 /// @param result Set to true if \a path is a symlink, false if it is not.
476 /// Undefined otherwise.
477 /// @returns errc::success if result has been successfully set, otherwise a
478 /// platform specific error_code.
479 error_code is_symlink(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 error_code status(const Twine &path, file_status &result);
489 /// @brief A version for when a file descriptor is already available.
490 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 error_code file_size(const Twine &Path, uint64_t &Result) {
500 error_code EC = status(Path, Status);
503 Result = Status.getSize();
504 return error_code::success();
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::not_supported on platforms
511 /// where the functionality isn't available.
512 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 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 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 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 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 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
571 SmallVectorImpl<char> &ResultPath);
573 error_code createUniqueDirectory(const Twine &Prefix,
574 SmallVectorImpl<char> &ResultPath);
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 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
606 unsigned Mode = 0666);
608 error_code openFileForRead(const Twine &Name, int &ResultFD);
610 /// @brief Are \a path's first bytes \a magic?
612 /// @param path Input path.
613 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
614 /// @returns errc::success if result has been successfully set, otherwise a
615 /// platform specific error_code.
616 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
618 /// @brief Get \a path's first \a len bytes.
620 /// @param path Input path.
621 /// @param len Number of magic bytes to get.
622 /// @param result Set to the first \a len bytes in the file pointed to by
623 /// \a path. Or the entire file if file_size(path) < len, in which
624 /// case result.size() returns the size of the file.
625 /// @returns errc::success if result has been successfully set,
626 /// errc::value_too_large if len is larger then the file pointed to by
627 /// \a path, otherwise a platform specific error_code.
628 error_code get_magic(const Twine &path, uint32_t len,
629 SmallVectorImpl<char> &result);
631 /// @brief Identify the type of a binary file based on how magical it is.
632 file_magic identify_magic(StringRef magic);
634 /// @brief Get and identify \a path's type based on its content.
636 /// @param path Input path.
637 /// @param result Set to the type of file, or file_magic::unknown.
638 /// @returns errc::success if result has been successfully set, otherwise a
639 /// platform specific error_code.
640 error_code identify_magic(const Twine &path, file_magic &result);
642 error_code getUniqueID(const Twine Path, UniqueID &Result);
644 /// This class represents a memory mapped file. It is based on
645 /// boost::iostreams::mapped_file.
646 class mapped_file_region {
647 mapped_file_region() LLVM_DELETED_FUNCTION;
648 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
649 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
653 readonly, ///< May only access map via const_data as read only.
654 readwrite, ///< May access map via data and modify it. Written to path.
655 priv ///< May modify via data, but changes are lost on destruction.
659 /// Platform specific mapping state.
666 void *FileMappingHandle;
669 error_code init(int FD, bool CloseFD, uint64_t Offset);
672 typedef char char_type;
674 mapped_file_region(mapped_file_region&&);
675 mapped_file_region &operator =(mapped_file_region&&);
677 /// Construct a mapped_file_region at \a path starting at \a offset of length
678 /// \a length and with access \a mode.
680 /// \param path Path to the file to map. If it does not exist it will be
682 /// \param mode How to map the memory.
683 /// \param length Number of bytes to map in starting at \a offset. If the file
684 /// is shorter than this, it will be extended. If \a length is
685 /// 0, the entire file will be mapped.
686 /// \param offset Byte offset from the beginning of the file where the map
687 /// should begin. Must be a multiple of
688 /// mapped_file_region::alignment().
689 /// \param ec This is set to errc::success if the map was constructed
690 /// successfully. Otherwise it is set to a platform dependent error.
691 mapped_file_region(const Twine &path,
697 /// \param fd An open file descriptor to map. mapped_file_region takes
698 /// ownership if closefd is true. It must have been opended in the correct
700 mapped_file_region(int fd,
707 ~mapped_file_region();
709 mapmode flags() const;
710 uint64_t size() const;
713 /// Get a const view of the data. Modifying this memory has undefined
715 const char *const_data() const;
717 /// \returns The minimum alignment offset must be.
718 static int alignment();
721 /// @brief Memory maps the contents of a file
723 /// @param path Path to file to map.
724 /// @param file_offset Byte offset in file where mapping should begin.
725 /// @param size Byte length of range of the file to map.
726 /// @param map_writable If true, the file will be mapped in r/w such
727 /// that changes to the mapped buffer will be flushed back
728 /// to the file. If false, the file will be mapped read-only
729 /// and the buffer will be read-only.
730 /// @param result Set to the start address of the mapped buffer.
731 /// @returns errc::success if result has been successfully set, otherwise a
732 /// platform specific error_code.
733 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
734 bool map_writable, void *&result);
737 /// @brief Memory unmaps the contents of a file
739 /// @param base Pointer to the start of the buffer.
740 /// @param size Byte length of the range to unmmap.
741 /// @returns errc::success if result has been successfully set, otherwise a
742 /// platform specific error_code.
743 error_code unmap_file_pages(void *base, size_t size);
745 /// Return the path to the main executable, given the value of argv[0] from
746 /// program startup and the address of main itself. In extremis, this function
747 /// may fail and return an empty path.
748 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
754 /// directory_entry - A single entry in a directory. Caches the status either
755 /// from the result of the iteration syscall, or the first time status is
757 class directory_entry {
759 mutable file_status Status;
762 explicit directory_entry(const Twine &path, file_status st = file_status())
768 void assign(const Twine &path, file_status st = file_status()) {
773 void replace_filename(const Twine &filename, file_status st = file_status());
775 const std::string &path() const { return Path; }
776 error_code status(file_status &result) const;
778 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
779 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
780 bool operator< (const directory_entry& rhs) const;
781 bool operator<=(const directory_entry& rhs) const;
782 bool operator> (const directory_entry& rhs) const;
783 bool operator>=(const directory_entry& rhs) const;
789 error_code directory_iterator_construct(DirIterState&, StringRef);
790 error_code directory_iterator_increment(DirIterState&);
791 error_code directory_iterator_destruct(DirIterState&);
793 /// DirIterState - Keeps state for the directory_iterator. It is reference
794 /// counted in order to preserve InputIterator semantics on copy.
795 struct DirIterState : public RefCountedBase<DirIterState> {
797 : IterationHandle(0) {}
800 directory_iterator_destruct(*this);
803 intptr_t IterationHandle;
804 directory_entry CurrentEntry;
808 /// directory_iterator - Iterates through the entries in path. There is no
809 /// operator++ because we need an error_code. If it's really needed we can make
810 /// it call report_fatal_error on error.
811 class directory_iterator {
812 IntrusiveRefCntPtr<detail::DirIterState> State;
815 explicit directory_iterator(const Twine &path, error_code &ec) {
816 State = new detail::DirIterState;
817 SmallString<128> path_storage;
818 ec = detail::directory_iterator_construct(*State,
819 path.toStringRef(path_storage));
822 explicit directory_iterator(const directory_entry &de, error_code &ec) {
823 State = new detail::DirIterState;
824 ec = detail::directory_iterator_construct(*State, de.path());
827 /// Construct end iterator.
828 directory_iterator() : State(0) {}
830 // No operator++ because we need error_code.
831 directory_iterator &increment(error_code &ec) {
832 ec = directory_iterator_increment(*State);
836 const directory_entry &operator*() const { return State->CurrentEntry; }
837 const directory_entry *operator->() const { return &State->CurrentEntry; }
839 bool operator==(const directory_iterator &RHS) const {
840 if (State == RHS.State)
843 return State->CurrentEntry == directory_entry();
845 return RHS.State->CurrentEntry == directory_entry();
846 return State->CurrentEntry == RHS.State->CurrentEntry;
849 bool operator!=(const directory_iterator &RHS) const {
850 return !(*this == RHS);
852 // Other members as required by
853 // C++ Std, 24.1.1 Input iterators [input.iterators]
857 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
858 /// reference counted in order to preserve InputIterator semantics on copy.
859 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
862 , HasNoPushRequest(false) {}
864 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
866 bool HasNoPushRequest;
870 /// recursive_directory_iterator - Same as directory_iterator except for it
871 /// recurses down into child directories.
872 class recursive_directory_iterator {
873 IntrusiveRefCntPtr<detail::RecDirIterState> State;
876 recursive_directory_iterator() {}
877 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
878 : State(new detail::RecDirIterState) {
879 State->Stack.push(directory_iterator(path, ec));
880 if (State->Stack.top() == directory_iterator())
883 // No operator++ because we need error_code.
884 recursive_directory_iterator &increment(error_code &ec) {
885 const directory_iterator end_itr;
887 if (State->HasNoPushRequest)
888 State->HasNoPushRequest = false;
891 if ((ec = State->Stack.top()->status(st))) return *this;
892 if (is_directory(st)) {
893 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
894 if (ec) return *this;
895 if (State->Stack.top() != end_itr) {
903 while (!State->Stack.empty()
904 && State->Stack.top().increment(ec) == end_itr) {
909 // Check if we are done. If so, create an end iterator.
910 if (State->Stack.empty())
916 const directory_entry &operator*() const { return *State->Stack.top(); }
917 const directory_entry *operator->() const { return &*State->Stack.top(); }
920 /// Gets the current level. Starting path is at level 0.
921 int level() const { return State->Level; }
923 /// Returns true if no_push has been called for this directory_entry.
924 bool no_push_request() const { return State->HasNoPushRequest; }
927 /// Goes up one level if Level > 0.
929 assert(State && "Cannot pop an end iterator!");
930 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
932 const directory_iterator end_itr;
936 report_fatal_error("Error incrementing directory iterator.");
939 } while (!State->Stack.empty()
940 && State->Stack.top().increment(ec) == end_itr);
942 // Check if we are done. If so, create an end iterator.
943 if (State->Stack.empty())
947 /// Does not go down into the current directory_entry.
948 void no_push() { State->HasNoPushRequest = true; }
950 bool operator==(const recursive_directory_iterator &RHS) const {
951 return State == RHS.State;
954 bool operator!=(const recursive_directory_iterator &RHS) const {
955 return !(*this == RHS);
957 // Other members as required by
958 // C++ Std, 24.1.1 Input iterators [input.iterators]
963 } // end namespace fs
964 } // end namespace sys
965 } // end namespace llvm