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 link from \a from to \a to.
290 /// The link may be a soft or a hard link, depending on the platform. The caller
291 /// may not assume which one. Currently on windows it creates a hard link since
292 /// soft links require extra privileges. On unix, it creates a soft link since
293 /// hard links don't work on SMB file systems.
295 /// @param to The path to hard link to.
296 /// @param from The path to hard link from. This is created.
297 /// @returns errc::success if the link was created, otherwise a platform
298 /// specific error_code.
299 error_code create_link(const Twine &to, const Twine &from);
301 /// @brief Get the current path.
303 /// @param result Holds the current path on return.
304 /// @returns errc::success if the current path has been stored in result,
305 /// otherwise a platform specific error_code.
306 error_code current_path(SmallVectorImpl<char> &result);
308 /// @brief Remove path. Equivalent to POSIX remove().
310 /// @param path Input path.
311 /// @returns errc::success if path has been removed or didn't exist, otherwise a
312 /// platform specific error code. If IgnoreNonExisting is false, also
313 /// returns error if the file didn't exist.
314 error_code remove(const Twine &path, bool IgnoreNonExisting = true);
316 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
318 /// @param from The path to rename from.
319 /// @param to The path to rename to. This is created.
320 error_code rename(const Twine &from, const Twine &to);
322 /// @brief Resize path to size. File is resized as if by POSIX truncate().
324 /// @param path Input path.
325 /// @param size Size to resize to.
326 /// @returns errc::success if \a path has been resized to \a size, otherwise a
327 /// platform specific error_code.
328 error_code resize_file(const Twine &path, uint64_t size);
331 /// @name Physical Observers
334 /// @brief Does file exist?
336 /// @param status A file_status previously returned from stat.
337 /// @returns True if the file represented by status exists, false if it does
339 bool exists(file_status status);
341 /// @brief Does file exist?
343 /// @param path Input path.
344 /// @param result Set to true if the file represented by status exists, false if
345 /// it does not. Undefined otherwise.
346 /// @returns errc::success if result has been successfully set, otherwise a
347 /// platform specific error_code.
348 error_code exists(const Twine &path, bool &result);
350 /// @brief Simpler version of exists for clients that don't need to
351 /// differentiate between an error and false.
352 inline bool exists(const Twine &path) {
354 return !exists(path, result) && result;
357 /// @brief Can we execute this file?
359 /// @param Path Input path.
360 /// @returns True if we can execute it, false otherwise.
361 bool can_execute(const Twine &Path);
363 /// @brief Can we write this file?
365 /// @param Path Input path.
366 /// @returns True if we can write to it, false otherwise.
367 bool can_write(const Twine &Path);
369 /// @brief Do file_status's represent the same thing?
371 /// @param A Input file_status.
372 /// @param B Input file_status.
374 /// assert(status_known(A) || status_known(B));
376 /// @returns True if A and B both represent the same file system entity, false
378 bool equivalent(file_status A, file_status B);
380 /// @brief Do paths represent the same thing?
382 /// assert(status_known(A) || status_known(B));
384 /// @param A Input path A.
385 /// @param B Input path B.
386 /// @param result Set to true if stat(A) and stat(B) have the same device and
387 /// inode (or equivalent).
388 /// @returns errc::success if result has been successfully set, otherwise a
389 /// platform specific error_code.
390 error_code equivalent(const Twine &A, const Twine &B, bool &result);
392 /// @brief Simpler version of equivalent for clients that don't need to
393 /// differentiate between an error and false.
394 inline bool equivalent(const Twine &A, const Twine &B) {
396 return !equivalent(A, B, result) && result;
399 /// @brief Does status represent a directory?
401 /// @param status A file_status previously returned from status.
402 /// @returns status.type() == file_type::directory_file.
403 bool is_directory(file_status status);
405 /// @brief Is path a directory?
407 /// @param path Input path.
408 /// @param result Set to true if \a path is a directory, false if it is not.
409 /// Undefined otherwise.
410 /// @returns errc::success if result has been successfully set, otherwise a
411 /// platform specific error_code.
412 error_code is_directory(const Twine &path, bool &result);
414 /// @brief Simpler version of is_directory for clients that don't need to
415 /// differentiate between an error and false.
416 inline bool is_directory(const Twine &Path) {
418 return !is_directory(Path, Result) && Result;
421 /// @brief Does status represent a regular file?
423 /// @param status A file_status previously returned from status.
424 /// @returns status_known(status) && status.type() == file_type::regular_file.
425 bool is_regular_file(file_status status);
427 /// @brief Is path a regular file?
429 /// @param path Input path.
430 /// @param result Set to true if \a path is a regular file, 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 error_code is_regular_file(const Twine &path, bool &result);
436 /// @brief Simpler version of is_regular_file for clients that don't need to
437 /// differentiate between an error and false.
438 inline bool is_regular_file(const Twine &Path) {
440 if (is_regular_file(Path, Result))
445 /// @brief Does this status represent something that exists but is not a
446 /// directory, regular file, or symlink?
448 /// @param status A file_status previously returned from status.
449 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
451 bool is_other(file_status status);
453 /// @brief Is path something that exists but is not a directory,
454 /// regular file, or symlink?
456 /// @param path Input path.
457 /// @param result Set to true if \a path exists, but is not a directory, regular
458 /// file, or a symlink, false if it does not. Undefined otherwise.
459 /// @returns errc::success if result has been successfully set, otherwise a
460 /// platform specific error_code.
461 error_code is_other(const Twine &path, bool &result);
463 /// @brief Does status represent a symlink?
465 /// @param status A file_status previously returned from stat.
466 /// @returns status.type() == symlink_file.
467 bool is_symlink(file_status status);
469 /// @brief Is path a symlink?
471 /// @param path Input path.
472 /// @param result Set to true if \a path is a symlink, false if it is not.
473 /// Undefined otherwise.
474 /// @returns errc::success if result has been successfully set, otherwise a
475 /// platform specific error_code.
476 error_code is_symlink(const Twine &path, bool &result);
478 /// @brief Get file status as if by POSIX stat().
480 /// @param path Input path.
481 /// @param result Set to the file status.
482 /// @returns errc::success if result has been successfully set, otherwise a
483 /// platform specific error_code.
484 error_code status(const Twine &path, file_status &result);
486 /// @brief A version for when a file descriptor is already available.
487 error_code status(int FD, file_status &Result);
489 /// @brief Get file size.
491 /// @param Path Input path.
492 /// @param Result Set to the size of the file in \a Path.
493 /// @returns errc::success if result has been successfully set, otherwise a
494 /// platform specific error_code.
495 inline error_code file_size(const Twine &Path, uint64_t &Result) {
497 error_code EC = status(Path, Status);
500 Result = Status.getSize();
501 return error_code::success();
504 /// @brief Set the file modification and access time.
506 /// @returns errc::success if the file times were successfully set, otherwise a
507 /// platform specific error_code or errc::not_supported on platforms
508 /// where the functionality isn't available.
509 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
511 /// @brief Is status available?
513 /// @param s Input file status.
514 /// @returns True if status() != status_error.
515 bool status_known(file_status s);
517 /// @brief Is status available?
519 /// @param path Input path.
520 /// @param result Set to true if status() != status_error.
521 /// @returns errc::success if result has been successfully set, otherwise a
522 /// platform specific error_code.
523 error_code status_known(const Twine &path, bool &result);
525 /// @brief Create a uniquely named file.
527 /// Generates a unique path suitable for a temporary file and then opens it as a
528 /// file. The name is based on \a model with '%' replaced by a random char in
529 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
530 /// directory will be prepended.
532 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
534 /// This is an atomic operation. Either the file is created and opened, or the
535 /// file system is left untouched.
537 /// The intendend use is for files that are to be kept, possibly after
538 /// renaming them. For example, when running 'clang -c foo.o', the file can
539 /// be first created as foo-abc123.o and then renamed.
541 /// @param Model Name to base unique path off of.
542 /// @param ResultFD Set to the opened file's file descriptor.
543 /// @param ResultPath Set to the opened file's absolute path.
544 /// @returns errc::success if Result{FD,Path} have been successfully set,
545 /// otherwise a platform specific error_code.
546 error_code createUniqueFile(const Twine &Model, int &ResultFD,
547 SmallVectorImpl<char> &ResultPath,
548 unsigned Mode = all_read | all_write);
550 /// @brief Simpler version for clients that don't want an open file.
551 error_code createUniqueFile(const Twine &Model,
552 SmallVectorImpl<char> &ResultPath);
554 /// @brief Create a file in the system temporary directory.
556 /// The filename is of the form prefix-random_chars.suffix. Since the directory
557 /// is not know to the caller, Prefix and Suffix cannot have path separators.
558 /// The files are created with mode 0600.
560 /// This should be used for things like a temporary .s that is removed after
561 /// running the assembler.
562 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
564 SmallVectorImpl<char> &ResultPath);
566 /// @brief Simpler version for clients that don't want an open file.
567 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
568 SmallVectorImpl<char> &ResultPath);
570 error_code createUniqueDirectory(const Twine &Prefix,
571 SmallVectorImpl<char> &ResultPath);
576 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
577 /// report an error if the file already exists.
580 /// F_Append - When opening a file, if it already exists append to the
581 /// existing file instead of returning an error. This may not be specified
585 /// The file should be opened in text mode on platforms that make this
589 /// Open the file for read and write.
593 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
594 return OpenFlags(unsigned(A) | unsigned(B));
597 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
602 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
603 unsigned Mode = 0666);
605 error_code openFileForRead(const Twine &Name, int &ResultFD);
607 /// @brief Are \a path's first bytes \a magic?
609 /// @param path Input path.
610 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
611 /// @returns errc::success if result has been successfully set, otherwise a
612 /// platform specific error_code.
613 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
615 /// @brief Get \a path's first \a len bytes.
617 /// @param path Input path.
618 /// @param len Number of magic bytes to get.
619 /// @param result Set to the first \a len bytes in the file pointed to by
620 /// \a path. Or the entire file if file_size(path) < len, in which
621 /// case result.size() returns the size of the file.
622 /// @returns errc::success if result has been successfully set,
623 /// errc::value_too_large if len is larger then the file pointed to by
624 /// \a path, otherwise a platform specific error_code.
625 error_code get_magic(const Twine &path, uint32_t len,
626 SmallVectorImpl<char> &result);
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 error_code identify_magic(const Twine &path, file_magic &result);
639 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() LLVM_DELETED_FUNCTION;
645 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
646 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
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.
663 void *FileMappingHandle;
666 error_code init(int FD, bool CloseFD, uint64_t Offset);
669 typedef char char_type;
671 mapped_file_region(mapped_file_region&&);
672 mapped_file_region &operator =(mapped_file_region&&);
674 /// Construct a mapped_file_region at \a path starting at \a offset of length
675 /// \a length and with access \a mode.
677 /// \param path Path to the file to map. If it does not exist it will be
679 /// \param mode How to map the memory.
680 /// \param length Number of bytes to map in starting at \a offset. If the file
681 /// is shorter than this, it will be extended. If \a length is
682 /// 0, the entire file will be mapped.
683 /// \param offset Byte offset from the beginning of the file where the map
684 /// should begin. Must be a multiple of
685 /// mapped_file_region::alignment().
686 /// \param ec This is set to errc::success if the map was constructed
687 /// successfully. Otherwise it is set to a platform dependent error.
688 mapped_file_region(const Twine &path,
694 /// \param fd An open file descriptor to map. mapped_file_region takes
695 /// ownership if closefd is true. It must have been opended in the correct
697 mapped_file_region(int fd,
704 ~mapped_file_region();
706 mapmode flags() const;
707 uint64_t size() const;
710 /// Get a const view of the data. Modifying this memory has undefined
712 const char *const_data() const;
714 /// \returns The minimum alignment offset must be.
715 static int alignment();
718 /// @brief Memory maps the contents of a file
720 /// @param path Path to file to map.
721 /// @param file_offset Byte offset in file where mapping should begin.
722 /// @param size Byte length of range of the file to map.
723 /// @param map_writable If true, the file will be mapped in r/w such
724 /// that changes to the mapped buffer will be flushed back
725 /// to the file. If false, the file will be mapped read-only
726 /// and the buffer will be read-only.
727 /// @param result Set to the start address of the mapped buffer.
728 /// @returns errc::success if result has been successfully set, otherwise a
729 /// platform specific error_code.
730 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
731 bool map_writable, void *&result);
734 /// @brief Memory unmaps the contents of a file
736 /// @param base Pointer to the start of the buffer.
737 /// @param size Byte length of the range to unmmap.
738 /// @returns errc::success if result has been successfully set, otherwise a
739 /// platform specific error_code.
740 error_code unmap_file_pages(void *base, size_t size);
742 /// Return the path to the main executable, given the value of argv[0] from
743 /// program startup and the address of main itself. In extremis, this function
744 /// may fail and return an empty path.
745 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
751 /// directory_entry - A single entry in a directory. Caches the status either
752 /// from the result of the iteration syscall, or the first time status is
754 class directory_entry {
756 mutable file_status Status;
759 explicit directory_entry(const Twine &path, file_status st = file_status())
765 void assign(const Twine &path, file_status st = file_status()) {
770 void replace_filename(const Twine &filename, file_status st = file_status());
772 const std::string &path() const { return Path; }
773 error_code status(file_status &result) const;
775 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
776 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
777 bool operator< (const directory_entry& rhs) const;
778 bool operator<=(const directory_entry& rhs) const;
779 bool operator> (const directory_entry& rhs) const;
780 bool operator>=(const directory_entry& rhs) const;
786 error_code directory_iterator_construct(DirIterState&, StringRef);
787 error_code directory_iterator_increment(DirIterState&);
788 error_code directory_iterator_destruct(DirIterState&);
790 /// DirIterState - Keeps state for the directory_iterator. It is reference
791 /// counted in order to preserve InputIterator semantics on copy.
792 struct DirIterState : public RefCountedBase<DirIterState> {
794 : IterationHandle(0) {}
797 directory_iterator_destruct(*this);
800 intptr_t IterationHandle;
801 directory_entry CurrentEntry;
805 /// directory_iterator - Iterates through the entries in path. There is no
806 /// operator++ because we need an error_code. If it's really needed we can make
807 /// it call report_fatal_error on error.
808 class directory_iterator {
809 IntrusiveRefCntPtr<detail::DirIterState> State;
812 explicit directory_iterator(const Twine &path, error_code &ec) {
813 State = new detail::DirIterState;
814 SmallString<128> path_storage;
815 ec = detail::directory_iterator_construct(*State,
816 path.toStringRef(path_storage));
819 explicit directory_iterator(const directory_entry &de, error_code &ec) {
820 State = new detail::DirIterState;
821 ec = detail::directory_iterator_construct(*State, de.path());
824 /// Construct end iterator.
825 directory_iterator() : State(0) {}
827 // No operator++ because we need error_code.
828 directory_iterator &increment(error_code &ec) {
829 ec = directory_iterator_increment(*State);
833 const directory_entry &operator*() const { return State->CurrentEntry; }
834 const directory_entry *operator->() const { return &State->CurrentEntry; }
836 bool operator==(const directory_iterator &RHS) const {
837 if (State == RHS.State)
840 return State->CurrentEntry == directory_entry();
842 return RHS.State->CurrentEntry == directory_entry();
843 return State->CurrentEntry == RHS.State->CurrentEntry;
846 bool operator!=(const directory_iterator &RHS) const {
847 return !(*this == RHS);
849 // Other members as required by
850 // C++ Std, 24.1.1 Input iterators [input.iterators]
854 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
855 /// reference counted in order to preserve InputIterator semantics on copy.
856 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
859 , HasNoPushRequest(false) {}
861 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
863 bool HasNoPushRequest;
867 /// recursive_directory_iterator - Same as directory_iterator except for it
868 /// recurses down into child directories.
869 class recursive_directory_iterator {
870 IntrusiveRefCntPtr<detail::RecDirIterState> State;
873 recursive_directory_iterator() {}
874 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
875 : State(new detail::RecDirIterState) {
876 State->Stack.push(directory_iterator(path, ec));
877 if (State->Stack.top() == directory_iterator())
880 // No operator++ because we need error_code.
881 recursive_directory_iterator &increment(error_code &ec) {
882 const directory_iterator end_itr;
884 if (State->HasNoPushRequest)
885 State->HasNoPushRequest = false;
888 if ((ec = State->Stack.top()->status(st))) return *this;
889 if (is_directory(st)) {
890 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
891 if (ec) return *this;
892 if (State->Stack.top() != end_itr) {
900 while (!State->Stack.empty()
901 && State->Stack.top().increment(ec) == end_itr) {
906 // Check if we are done. If so, create an end iterator.
907 if (State->Stack.empty())
913 const directory_entry &operator*() const { return *State->Stack.top(); }
914 const directory_entry *operator->() const { return &*State->Stack.top(); }
917 /// Gets the current level. Starting path is at level 0.
918 int level() const { return State->Level; }
920 /// Returns true if no_push has been called for this directory_entry.
921 bool no_push_request() const { return State->HasNoPushRequest; }
924 /// Goes up one level if Level > 0.
926 assert(State && "Cannot pop an end iterator!");
927 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
929 const directory_iterator end_itr;
933 report_fatal_error("Error incrementing directory iterator.");
936 } while (!State->Stack.empty()
937 && State->Stack.top().increment(ec) == end_itr);
939 // Check if we are done. If so, create an end iterator.
940 if (State->Stack.empty())
944 /// Does not go down into the current directory_entry.
945 void no_push() { State->HasNoPushRequest = true; }
947 bool operator==(const recursive_directory_iterator &RHS) const {
948 return State == RHS.State;
951 bool operator!=(const recursive_directory_iterator &RHS) const {
952 return !(*this == RHS);
954 // Other members as required by
955 // C++ Std, 24.1.1 Input iterators [input.iterators]
960 } // end namespace fs
961 } // end namespace sys
962 } // end namespace llvm