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/OwningPtr.h"
32 #include "llvm/ADT/SmallString.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/ErrorHandling.h"
36 #include "llvm/Support/TimeValue.h"
37 #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 Device < Other.Device ||
139 (Device == Other.Device && File < Other.File);
141 uint64_t getDevice() const { return Device; }
142 uint64_t getFile() const { return File; }
145 /// file_status - Represents the result of a call to stat and friends. It has
146 /// a platform specific member to store the result.
149 #if defined(LLVM_ON_UNIX)
156 #elif defined (LLVM_ON_WIN32)
157 uint32_t LastWriteTimeHigh;
158 uint32_t LastWriteTimeLow;
159 uint32_t VolumeSerialNumber;
160 uint32_t FileSizeHigh;
161 uint32_t FileSizeLow;
162 uint32_t FileIndexHigh;
163 uint32_t FileIndexLow;
165 friend bool equivalent(file_status A, file_status B);
169 file_status() : Type(file_type::status_error) {}
170 file_status(file_type Type) : Type(Type) {}
172 #if defined(LLVM_ON_UNIX)
173 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
174 uid_t UID, gid_t GID, off_t Size)
175 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
176 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
177 #elif defined(LLVM_ON_WIN32)
178 file_status(file_type Type, uint32_t LastWriteTimeHigh,
179 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
180 uint32_t FileSizeHigh, uint32_t FileSizeLow,
181 uint32_t FileIndexHigh, uint32_t FileIndexLow)
182 : LastWriteTimeHigh(LastWriteTimeHigh),
183 LastWriteTimeLow(LastWriteTimeLow),
184 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
185 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
186 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
190 file_type type() const { return Type; }
191 perms permissions() const { return Perms; }
192 TimeValue getLastModificationTime() const;
193 UniqueID getUniqueID() const;
195 #if defined(LLVM_ON_UNIX)
196 uint32_t getUser() const { return fs_st_uid; }
197 uint32_t getGroup() const { return fs_st_gid; }
198 uint64_t getSize() const { return fs_st_size; }
199 #elif defined (LLVM_ON_WIN32)
200 uint32_t getUser() const {
201 return 9999; // Not applicable to Windows, so...
203 uint32_t getGroup() const {
204 return 9999; // Not applicable to Windows, so...
206 uint64_t getSize() const {
207 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
212 void type(file_type v) { Type = v; }
213 void permissions(perms p) { Perms = p; }
216 /// file_magic - An "enum class" enumeration of file types based on magic (the first
217 /// N bytes of the file).
220 unknown = 0, ///< Unrecognized file
221 bitcode, ///< Bitcode file
222 archive, ///< ar style archive file
223 elf_relocatable, ///< ELF Relocatable object file
224 elf_executable, ///< ELF Executable image
225 elf_shared_object, ///< ELF dynamically linked shared lib
226 elf_core, ///< ELF core image
227 macho_object, ///< Mach-O Object file
228 macho_executable, ///< Mach-O Executable
229 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
230 macho_core, ///< Mach-O Core File
231 macho_preload_executable, ///< Mach-O Preloaded Executable
232 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
233 macho_dynamic_linker, ///< The Mach-O dynamic linker
234 macho_bundle, ///< Mach-O Bundle file
235 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
236 macho_dsym_companion, ///< Mach-O dSYM companion file
237 macho_universal_binary, ///< Mach-O universal binary
238 coff_object, ///< COFF object file
239 coff_import_library, ///< COFF import library
240 pecoff_executable, ///< PECOFF executable file
241 windows_resource ///< Windows compiled resource file (.rc)
244 bool is_object() const {
245 return V == unknown ? false : true;
248 file_magic() : V(unknown) {}
249 file_magic(Impl V) : V(V) {}
250 operator Impl() const { return V; }
257 /// @name Physical Operators
260 /// @brief Make \a path an absolute path.
262 /// Makes \a path absolute using the current directory if it is not already. An
263 /// empty \a path will result in the current directory.
265 /// /absolute/path => /absolute/path
266 /// relative/../path => <current-directory>/relative/../path
268 /// @param path A path that is modified to be an absolute path.
269 /// @returns errc::success if \a path has been made absolute, otherwise a
270 /// platform specific error_code.
271 error_code make_absolute(SmallVectorImpl<char> &path);
273 /// @brief Create all the non-existent directories in path.
275 /// @param path Directories to create.
276 /// @returns errc::success if is_directory(path), otherwise a platform
277 /// specific error_code. If IgnoreExisting is false, also returns
278 /// error if the directory already existed.
279 error_code create_directories(const Twine &path, bool IgnoreExisting = true);
281 /// @brief Create the directory in path.
283 /// @param path Directory to create.
284 /// @returns errc::success if is_directory(path), otherwise a platform
285 /// specific error_code. If IgnoreExisting is false, also returns
286 /// error if the directory already existed.
287 error_code create_directory(const Twine &path, bool IgnoreExisting = true);
289 /// @brief Create a hard link from \a from to \a to.
291 /// @param to The path to hard link to.
292 /// @param from The path to hard link from. This is created.
293 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
294 /// , otherwise a platform specific error_code.
295 error_code create_hard_link(const Twine &to, const Twine &from);
297 /// @brief Get the current path.
299 /// @param result Holds the current path on return.
300 /// @returns errc::success if the current path has been stored in result,
301 /// otherwise a platform specific error_code.
302 error_code current_path(SmallVectorImpl<char> &result);
304 /// @brief Remove path. Equivalent to POSIX remove().
306 /// @param path Input path.
307 /// @returns errc::success if path has been removed or didn't exist, otherwise a
308 /// platform specific error code. If IgnoreNonExisting is false, also
309 /// returns error if the file didn't exist.
310 error_code remove(const Twine &path, bool IgnoreNonExisting = true);
312 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
314 /// @param from The path to rename from.
315 /// @param to The path to rename to. This is created.
316 error_code rename(const Twine &from, const Twine &to);
318 /// @brief Resize path to size. File is resized as if by POSIX truncate().
320 /// @param path Input path.
321 /// @param size Size to resize to.
322 /// @returns errc::success if \a path has been resized to \a size, otherwise a
323 /// platform specific error_code.
324 error_code resize_file(const Twine &path, uint64_t size);
327 /// @name Physical Observers
330 /// @brief Does file exist?
332 /// @param status A file_status previously returned from stat.
333 /// @returns True if the file represented by status exists, false if it does
335 bool exists(file_status status);
337 /// @brief Does file exist?
339 /// @param path Input path.
340 /// @param result Set to true if the file represented by status exists, false if
341 /// it does not. Undefined otherwise.
342 /// @returns errc::success if result has been successfully set, otherwise a
343 /// platform specific error_code.
344 error_code exists(const Twine &path, bool &result);
346 /// @brief Simpler version of exists for clients that don't need to
347 /// differentiate between an error and false.
348 inline bool exists(const Twine &path) {
350 return !exists(path, result) && result;
353 /// @brief Can we execute this file?
355 /// @param Path Input path.
356 /// @returns True if we can execute it, false otherwise.
357 bool can_execute(const Twine &Path);
359 /// @brief Can we write this file?
361 /// @param Path Input path.
362 /// @returns True if we can write to it, false otherwise.
363 bool can_write(const Twine &Path);
365 /// @brief Do file_status's represent the same thing?
367 /// @param A Input file_status.
368 /// @param B Input file_status.
370 /// assert(status_known(A) || status_known(B));
372 /// @returns True if A and B both represent the same file system entity, false
374 bool equivalent(file_status A, file_status B);
376 /// @brief Do paths represent the same thing?
378 /// assert(status_known(A) || status_known(B));
380 /// @param A Input path A.
381 /// @param B Input path B.
382 /// @param result Set to true if stat(A) and stat(B) have the same device and
383 /// inode (or equivalent).
384 /// @returns errc::success if result has been successfully set, otherwise a
385 /// platform specific error_code.
386 error_code equivalent(const Twine &A, const Twine &B, bool &result);
388 /// @brief Simpler version of equivalent for clients that don't need to
389 /// differentiate between an error and false.
390 inline bool equivalent(const Twine &A, const Twine &B) {
392 return !equivalent(A, B, result) && result;
395 /// @brief Does status represent a directory?
397 /// @param status A file_status previously returned from status.
398 /// @returns status.type() == file_type::directory_file.
399 bool is_directory(file_status status);
401 /// @brief Is path a directory?
403 /// @param path Input path.
404 /// @param result Set to true if \a path is a directory, false if it is not.
405 /// Undefined otherwise.
406 /// @returns errc::success if result has been successfully set, otherwise a
407 /// platform specific error_code.
408 error_code is_directory(const Twine &path, bool &result);
410 /// @brief Simpler version of is_directory for clients that don't need to
411 /// differentiate between an error and false.
412 inline bool is_directory(const Twine &Path) {
414 return !is_directory(Path, Result) && Result;
417 /// @brief Does status represent a regular file?
419 /// @param status A file_status previously returned from status.
420 /// @returns status_known(status) && status.type() == file_type::regular_file.
421 bool is_regular_file(file_status status);
423 /// @brief Is path a regular file?
425 /// @param path Input path.
426 /// @param result Set to true if \a path is a regular file, false if it is not.
427 /// Undefined otherwise.
428 /// @returns errc::success if result has been successfully set, otherwise a
429 /// platform specific error_code.
430 error_code is_regular_file(const Twine &path, bool &result);
432 /// @brief Simpler version of is_regular_file for clients that don't need to
433 /// differentiate between an error and false.
434 inline bool is_regular_file(const Twine &Path) {
436 if (is_regular_file(Path, Result))
441 /// @brief Does this status represent something that exists but is not a
442 /// directory, regular file, or symlink?
444 /// @param status A file_status previously returned from status.
445 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
447 bool is_other(file_status status);
449 /// @brief Is path something that exists but is not a directory,
450 /// regular file, or symlink?
452 /// @param path Input path.
453 /// @param result Set to true if \a path exists, but is not a directory, regular
454 /// file, or a symlink, false if it does not. Undefined otherwise.
455 /// @returns errc::success if result has been successfully set, otherwise a
456 /// platform specific error_code.
457 error_code is_other(const Twine &path, bool &result);
459 /// @brief Does status represent a symlink?
461 /// @param status A file_status previously returned from stat.
462 /// @returns status.type() == symlink_file.
463 bool is_symlink(file_status status);
465 /// @brief Is path a symlink?
467 /// @param path Input path.
468 /// @param result Set to true if \a path is a symlink, false if it is not.
469 /// Undefined otherwise.
470 /// @returns errc::success if result has been successfully set, otherwise a
471 /// platform specific error_code.
472 error_code is_symlink(const Twine &path, bool &result);
474 /// @brief Get file status as if by POSIX stat().
476 /// @param path Input path.
477 /// @param result Set to the file status.
478 /// @returns errc::success if result has been successfully set, otherwise a
479 /// platform specific error_code.
480 error_code status(const Twine &path, file_status &result);
482 /// @brief A version for when a file descriptor is already available.
483 error_code status(int FD, file_status &Result);
485 /// @brief Get file size.
487 /// @param Path Input path.
488 /// @param Result Set to the size of the file in \a Path.
489 /// @returns errc::success if result has been successfully set, otherwise a
490 /// platform specific error_code.
491 inline error_code file_size(const Twine &Path, uint64_t &Result) {
493 error_code EC = status(Path, Status);
496 Result = Status.getSize();
497 return error_code::success();
500 /// @brief Set the file modification and access time.
502 /// @returns errc::success if the file times were successfully set, otherwise a
503 /// platform specific error_code or errc::not_supported on platforms
504 /// where the functionality isn't available.
505 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
507 /// @brief Is status available?
509 /// @param s Input file status.
510 /// @returns True if status() != status_error.
511 bool status_known(file_status s);
513 /// @brief Is status available?
515 /// @param path Input path.
516 /// @param result Set to true if status() != status_error.
517 /// @returns errc::success if result has been successfully set, otherwise a
518 /// platform specific error_code.
519 error_code status_known(const Twine &path, bool &result);
521 /// @brief Create a uniquely named file.
523 /// Generates a unique path suitable for a temporary file and then opens it as a
524 /// file. The name is based on \a model with '%' replaced by a random char in
525 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
526 /// directory will be prepended.
528 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
530 /// This is an atomic operation. Either the file is created and opened, or the
531 /// file system is left untouched.
533 /// The intendend use is for files that are to be kept, possibly after
534 /// renaming them. For example, when running 'clang -c foo.o', the file can
535 /// be first created as foo-abc123.o and then renamed.
537 /// @param Model Name to base unique path off of.
538 /// @param ResultFD Set to the opened file's file descriptor.
539 /// @param ResultPath Set to the opened file's absolute path.
540 /// @returns errc::success if Result{FD,Path} have been successfully set,
541 /// otherwise a platform specific error_code.
542 error_code createUniqueFile(const Twine &Model, int &ResultFD,
543 SmallVectorImpl<char> &ResultPath,
544 unsigned Mode = all_read | all_write);
546 /// @brief Simpler version for clients that don't want an open file.
547 error_code createUniqueFile(const Twine &Model,
548 SmallVectorImpl<char> &ResultPath);
550 /// @brief Create a file in the system temporary directory.
552 /// The filename is of the form prefix-random_chars.suffix. Since the directory
553 /// is not know to the caller, Prefix and Suffix cannot have path separators.
554 /// The files are created with mode 0600.
556 /// This should be used for things like a temporary .s that is removed after
557 /// running the assembler.
558 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
560 SmallVectorImpl<char> &ResultPath);
562 /// @brief Simpler version for clients that don't want an open file.
563 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
564 SmallVectorImpl<char> &ResultPath);
566 error_code createUniqueDirectory(const Twine &Prefix,
567 SmallVectorImpl<char> &ResultPath);
572 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
573 /// report an error if the file already exists.
576 /// F_Append - When opening a file, if it already exists append to the
577 /// existing file instead of returning an error. This may not be specified
581 /// The file should be opened in text mode on platforms that make this
585 /// Open the file for read and write.
589 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
590 return OpenFlags(unsigned(A) | unsigned(B));
593 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
598 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
599 unsigned Mode = 0666);
601 error_code openFileForRead(const Twine &Name, int &ResultFD);
603 /// @brief Are \a path's first bytes \a magic?
605 /// @param path Input path.
606 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
607 /// @returns errc::success if result has been successfully set, otherwise a
608 /// platform specific error_code.
609 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
611 /// @brief Get \a path's first \a len bytes.
613 /// @param path Input path.
614 /// @param len Number of magic bytes to get.
615 /// @param result Set to the first \a len bytes in the file pointed to by
616 /// \a path. Or the entire file if file_size(path) < len, in which
617 /// case result.size() returns the size of the file.
618 /// @returns errc::success if result has been successfully set,
619 /// errc::value_too_large if len is larger then the file pointed to by
620 /// \a path, otherwise a platform specific error_code.
621 error_code get_magic(const Twine &path, uint32_t len,
622 SmallVectorImpl<char> &result);
624 /// @brief Identify the type of a binary file based on how magical it is.
625 file_magic identify_magic(StringRef magic);
627 /// @brief Get and identify \a path's type based on its content.
629 /// @param path Input path.
630 /// @param result Set to the type of file, or file_magic::unknown.
631 /// @returns errc::success if result has been successfully set, otherwise a
632 /// platform specific error_code.
633 error_code identify_magic(const Twine &path, file_magic &result);
635 error_code getUniqueID(const Twine Path, UniqueID &Result);
637 /// This class represents a memory mapped file. It is based on
638 /// boost::iostreams::mapped_file.
639 class mapped_file_region {
640 mapped_file_region() LLVM_DELETED_FUNCTION;
641 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
642 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
646 readonly, ///< May only access map via const_data as read only.
647 readwrite, ///< May access map via data and modify it. Written to path.
648 priv ///< May modify via data, but changes are lost on destruction.
652 /// Platform specific mapping state.
659 void *FileMappingHandle;
662 error_code init(int FD, bool CloseFD, uint64_t Offset);
665 typedef char char_type;
667 mapped_file_region(mapped_file_region&&);
668 mapped_file_region &operator =(mapped_file_region&&);
670 /// Construct a mapped_file_region at \a path starting at \a offset of length
671 /// \a length and with access \a mode.
673 /// \param path Path to the file to map. If it does not exist it will be
675 /// \param mode How to map the memory.
676 /// \param length Number of bytes to map in starting at \a offset. If the file
677 /// is shorter than this, it will be extended. If \a length is
678 /// 0, the entire file will be mapped.
679 /// \param offset Byte offset from the beginning of the file where the map
680 /// should begin. Must be a multiple of
681 /// mapped_file_region::alignment().
682 /// \param ec This is set to errc::success if the map was constructed
683 /// successfully. Otherwise it is set to a platform dependent error.
684 mapped_file_region(const Twine &path,
690 /// \param fd An open file descriptor to map. mapped_file_region takes
691 /// ownership if closefd is true. It must have been opended in the correct
693 mapped_file_region(int fd,
700 ~mapped_file_region();
702 mapmode flags() const;
703 uint64_t size() const;
706 /// Get a const view of the data. Modifying this memory has undefined
708 const char *const_data() const;
710 /// \returns The minimum alignment offset must be.
711 static int alignment();
714 /// @brief Memory maps the contents of a file
716 /// @param path Path to file to map.
717 /// @param file_offset Byte offset in file where mapping should begin.
718 /// @param size Byte length of range of the file to map.
719 /// @param map_writable If true, the file will be mapped in r/w such
720 /// that changes to the mapped buffer will be flushed back
721 /// to the file. If false, the file will be mapped read-only
722 /// and the buffer will be read-only.
723 /// @param result Set to the start address of the mapped buffer.
724 /// @returns errc::success if result has been successfully set, otherwise a
725 /// platform specific error_code.
726 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
727 bool map_writable, void *&result);
730 /// @brief Memory unmaps the contents of a file
732 /// @param base Pointer to the start of the buffer.
733 /// @param size Byte length of the range to unmmap.
734 /// @returns errc::success if result has been successfully set, otherwise a
735 /// platform specific error_code.
736 error_code unmap_file_pages(void *base, size_t size);
738 /// Return the path to the main executable, given the value of argv[0] from
739 /// program startup and the address of main itself. In extremis, this function
740 /// may fail and return an empty path.
741 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
747 /// directory_entry - A single entry in a directory. Caches the status either
748 /// from the result of the iteration syscall, or the first time status is
750 class directory_entry {
752 mutable file_status Status;
755 explicit directory_entry(const Twine &path, file_status st = file_status())
761 void assign(const Twine &path, file_status st = file_status()) {
766 void replace_filename(const Twine &filename, file_status st = file_status());
768 const std::string &path() const { return Path; }
769 error_code status(file_status &result) const;
771 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
772 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
773 bool operator< (const directory_entry& rhs) const;
774 bool operator<=(const directory_entry& rhs) const;
775 bool operator> (const directory_entry& rhs) const;
776 bool operator>=(const directory_entry& rhs) const;
782 error_code directory_iterator_construct(DirIterState&, StringRef);
783 error_code directory_iterator_increment(DirIterState&);
784 error_code directory_iterator_destruct(DirIterState&);
786 /// DirIterState - Keeps state for the directory_iterator. It is reference
787 /// counted in order to preserve InputIterator semantics on copy.
788 struct DirIterState : public RefCountedBase<DirIterState> {
790 : IterationHandle(0) {}
793 directory_iterator_destruct(*this);
796 intptr_t IterationHandle;
797 directory_entry CurrentEntry;
801 /// directory_iterator - Iterates through the entries in path. There is no
802 /// operator++ because we need an error_code. If it's really needed we can make
803 /// it call report_fatal_error on error.
804 class directory_iterator {
805 IntrusiveRefCntPtr<detail::DirIterState> State;
808 explicit directory_iterator(const Twine &path, error_code &ec) {
809 State = new detail::DirIterState;
810 SmallString<128> path_storage;
811 ec = detail::directory_iterator_construct(*State,
812 path.toStringRef(path_storage));
815 explicit directory_iterator(const directory_entry &de, error_code &ec) {
816 State = new detail::DirIterState;
817 ec = detail::directory_iterator_construct(*State, de.path());
820 /// Construct end iterator.
821 directory_iterator() : State(0) {}
823 // No operator++ because we need error_code.
824 directory_iterator &increment(error_code &ec) {
825 ec = directory_iterator_increment(*State);
829 const directory_entry &operator*() const { return State->CurrentEntry; }
830 const directory_entry *operator->() const { return &State->CurrentEntry; }
832 bool operator==(const directory_iterator &RHS) const {
833 if (State == RHS.State)
836 return State->CurrentEntry == directory_entry();
838 return RHS.State->CurrentEntry == directory_entry();
839 return State->CurrentEntry == RHS.State->CurrentEntry;
842 bool operator!=(const directory_iterator &RHS) const {
843 return !(*this == RHS);
845 // Other members as required by
846 // C++ Std, 24.1.1 Input iterators [input.iterators]
850 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
851 /// reference counted in order to preserve InputIterator semantics on copy.
852 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
855 , HasNoPushRequest(false) {}
857 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
859 bool HasNoPushRequest;
863 /// recursive_directory_iterator - Same as directory_iterator except for it
864 /// recurses down into child directories.
865 class recursive_directory_iterator {
866 IntrusiveRefCntPtr<detail::RecDirIterState> State;
869 recursive_directory_iterator() {}
870 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
871 : State(new detail::RecDirIterState) {
872 State->Stack.push(directory_iterator(path, ec));
873 if (State->Stack.top() == directory_iterator())
876 // No operator++ because we need error_code.
877 recursive_directory_iterator &increment(error_code &ec) {
878 const directory_iterator end_itr;
880 if (State->HasNoPushRequest)
881 State->HasNoPushRequest = false;
884 if ((ec = State->Stack.top()->status(st))) return *this;
885 if (is_directory(st)) {
886 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
887 if (ec) return *this;
888 if (State->Stack.top() != end_itr) {
896 while (!State->Stack.empty()
897 && State->Stack.top().increment(ec) == end_itr) {
902 // Check if we are done. If so, create an end iterator.
903 if (State->Stack.empty())
909 const directory_entry &operator*() const { return *State->Stack.top(); }
910 const directory_entry *operator->() const { return &*State->Stack.top(); }
913 /// Gets the current level. Starting path is at level 0.
914 int level() const { return State->Level; }
916 /// Returns true if no_push has been called for this directory_entry.
917 bool no_push_request() const { return State->HasNoPushRequest; }
920 /// Goes up one level if Level > 0.
922 assert(State && "Cannot pop an end iterator!");
923 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
925 const directory_iterator end_itr;
929 report_fatal_error("Error incrementing directory iterator.");
932 } while (!State->Stack.empty()
933 && State->Stack.top().increment(ec) == end_itr);
935 // Check if we are done. If so, create an end iterator.
936 if (State->Stack.empty())
940 /// Does not go down into the current directory_entry.
941 void no_push() { State->HasNoPushRequest = true; }
943 bool operator==(const recursive_directory_iterator &RHS) const {
944 return State == RHS.State;
947 bool operator!=(const recursive_directory_iterator &RHS) const {
948 return !(*this == RHS);
950 // Other members as required by
951 // C++ Std, 24.1.1 Input iterators [input.iterators]
956 } // end namespace fs
957 } // end namespace sys
958 } // end namespace llvm