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 /// @param existed Set to true if \a path already existed, false otherwise.
277 /// @returns errc::success if is_directory(path) and existed have been set,
278 /// otherwise a platform specific error_code.
279 error_code create_directories(const Twine &path, bool &existed);
281 /// @brief Convenience function for clients that don't need to know if the
282 /// directory existed or not.
283 inline error_code create_directories(const Twine &Path) {
285 return create_directories(Path, Existed);
288 /// @brief Create the directory in path.
290 /// @param path Directory to create.
291 /// @param existed Set to true if \a path already existed, false otherwise.
292 /// @returns errc::success if is_directory(path) and existed have been set,
293 /// otherwise a platform specific error_code.
294 error_code create_directory(const Twine &path, bool &existed);
296 /// @brief Convenience function for clients that don't need to know if the
297 /// directory existed or not.
298 inline error_code create_directory(const Twine &Path) {
300 return create_directory(Path, Existed);
303 /// @brief Create a hard link from \a from to \a to.
305 /// @param to The path to hard link to.
306 /// @param from The path to hard link from. This is created.
307 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
308 /// , otherwise a platform specific error_code.
309 error_code create_hard_link(const Twine &to, const Twine &from);
311 /// @brief Get the current path.
313 /// @param result Holds the current path on return.
314 /// @returns errc::success if the current path has been stored in result,
315 /// otherwise a platform specific error_code.
316 error_code current_path(SmallVectorImpl<char> &result);
318 /// @brief Remove path. Equivalent to POSIX remove().
320 /// @param path Input path.
321 /// @param existed Set to true if \a path existed, false if it did not.
322 /// undefined otherwise.
323 /// @returns errc::success if path has been removed and existed has been
324 /// successfully set, otherwise a platform specific error_code.
325 error_code remove(const Twine &path, bool &existed);
327 /// @brief Convenience function for clients that don't need to know if the file
329 inline error_code remove(const Twine &Path) {
331 return remove(Path, Existed);
334 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
336 /// @param from The path to rename from.
337 /// @param to The path to rename to. This is created.
338 error_code rename(const Twine &from, const Twine &to);
340 /// @brief Resize path to size. File is resized as if by POSIX truncate().
342 /// @param path Input path.
343 /// @param size Size to resize to.
344 /// @returns errc::success if \a path has been resized to \a size, otherwise a
345 /// platform specific error_code.
346 error_code resize_file(const Twine &path, uint64_t size);
349 /// @name Physical Observers
352 /// @brief Does file exist?
354 /// @param status A file_status previously returned from stat.
355 /// @returns True if the file represented by status exists, false if it does
357 bool exists(file_status status);
359 /// @brief Does file exist?
361 /// @param path Input path.
362 /// @param result Set to true if the file represented by status exists, false if
363 /// it does not. Undefined otherwise.
364 /// @returns errc::success if result has been successfully set, otherwise a
365 /// platform specific error_code.
366 error_code exists(const Twine &path, bool &result);
368 /// @brief Simpler version of exists for clients that don't need to
369 /// differentiate between an error and false.
370 inline bool exists(const Twine &path) {
372 return !exists(path, result) && result;
375 /// @brief Can we execute this file?
377 /// @param Path Input path.
378 /// @returns True if we can execute it, false otherwise.
379 bool can_execute(const Twine &Path);
381 /// @brief Can we write this file?
383 /// @param Path Input path.
384 /// @returns True if we can write to it, false otherwise.
385 bool can_write(const Twine &Path);
387 /// @brief Do file_status's represent the same thing?
389 /// @param A Input file_status.
390 /// @param B Input file_status.
392 /// assert(status_known(A) || status_known(B));
394 /// @returns True if A and B both represent the same file system entity, false
396 bool equivalent(file_status A, file_status B);
398 /// @brief Do paths represent the same thing?
400 /// assert(status_known(A) || status_known(B));
402 /// @param A Input path A.
403 /// @param B Input path B.
404 /// @param result Set to true if stat(A) and stat(B) have the same device and
405 /// inode (or equivalent).
406 /// @returns errc::success if result has been successfully set, otherwise a
407 /// platform specific error_code.
408 error_code equivalent(const Twine &A, const Twine &B, bool &result);
410 /// @brief Simpler version of equivalent for clients that don't need to
411 /// differentiate between an error and false.
412 inline bool equivalent(const Twine &A, const Twine &B) {
414 return !equivalent(A, B, result) && result;
417 /// @brief Does status represent a directory?
419 /// @param status A file_status previously returned from status.
420 /// @returns status.type() == file_type::directory_file.
421 bool is_directory(file_status status);
423 /// @brief Is path a directory?
425 /// @param path Input path.
426 /// @param result Set to true if \a path is a directory, 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_directory(const Twine &path, bool &result);
432 /// @brief Simpler version of is_directory for clients that don't need to
433 /// differentiate between an error and false.
434 inline bool is_directory(const Twine &Path) {
436 return !is_directory(Path, Result) && Result;
439 /// @brief Does status represent a regular file?
441 /// @param status A file_status previously returned from status.
442 /// @returns status_known(status) && status.type() == file_type::regular_file.
443 bool is_regular_file(file_status status);
445 /// @brief Is path a regular file?
447 /// @param path Input path.
448 /// @param result Set to true if \a path is a regular file, false if it is not.
449 /// Undefined otherwise.
450 /// @returns errc::success if result has been successfully set, otherwise a
451 /// platform specific error_code.
452 error_code is_regular_file(const Twine &path, bool &result);
454 /// @brief Simpler version of is_regular_file for clients that don't need to
455 /// differentiate between an error and false.
456 inline bool is_regular_file(const Twine &Path) {
458 if (is_regular_file(Path, Result))
463 /// @brief Does this status represent something that exists but is not a
464 /// directory, regular file, or symlink?
466 /// @param status A file_status previously returned from status.
467 /// @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 error_code is_other(const Twine &path, bool &result);
481 /// @brief Does status represent a symlink?
483 /// @param status A file_status previously returned from stat.
484 /// @returns status.type() == symlink_file.
485 bool is_symlink(file_status status);
487 /// @brief Is path a symlink?
489 /// @param path Input path.
490 /// @param result Set to true if \a path is a symlink, false if it is not.
491 /// Undefined otherwise.
492 /// @returns errc::success if result has been successfully set, otherwise a
493 /// platform specific error_code.
494 error_code is_symlink(const Twine &path, bool &result);
496 /// @brief Get file status as if by POSIX stat().
498 /// @param path Input path.
499 /// @param result Set to the file status.
500 /// @returns errc::success if result has been successfully set, otherwise a
501 /// platform specific error_code.
502 error_code status(const Twine &path, file_status &result);
504 /// @brief A version for when a file descriptor is already available.
505 error_code status(int FD, file_status &Result);
507 /// @brief Get file size.
509 /// @param Path Input path.
510 /// @param Result Set to the size of the file in \a Path.
511 /// @returns errc::success if result has been successfully set, otherwise a
512 /// platform specific error_code.
513 inline error_code file_size(const Twine &Path, uint64_t &Result) {
515 error_code EC = status(Path, Status);
518 Result = Status.getSize();
519 return error_code::success();
522 /// @brief Set the file modification and access time.
524 /// @returns errc::success if the file times were successfully set, otherwise a
525 /// platform specific error_code or errc::not_supported on platforms
526 /// where the functionality isn't available.
527 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
529 /// @brief Is status available?
531 /// @param s Input file status.
532 /// @returns True if status() != status_error.
533 bool status_known(file_status s);
535 /// @brief Is status available?
537 /// @param path Input path.
538 /// @param result Set to true if status() != status_error.
539 /// @returns errc::success if result has been successfully set, otherwise a
540 /// platform specific error_code.
541 error_code status_known(const Twine &path, bool &result);
543 /// @brief Create a uniquely named file.
545 /// Generates a unique path suitable for a temporary file and then opens it as a
546 /// file. The name is based on \a model with '%' replaced by a random char in
547 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
548 /// directory will be prepended.
550 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
552 /// This is an atomic operation. Either the file is created and opened, or the
553 /// file system is left untouched.
555 /// The intendend use is for files that are to be kept, possibly after
556 /// renaming them. For example, when running 'clang -c foo.o', the file can
557 /// be first created as foo-abc123.o and then renamed.
559 /// @param Model Name to base unique path off of.
560 /// @param ResultFD Set to the opened file's file descriptor.
561 /// @param ResultPath Set to the opened file's absolute path.
562 /// @returns errc::success if Result{FD,Path} have been successfully set,
563 /// otherwise a platform specific error_code.
564 error_code createUniqueFile(const Twine &Model, int &ResultFD,
565 SmallVectorImpl<char> &ResultPath,
566 unsigned Mode = all_read | all_write);
568 /// @brief Simpler version for clients that don't want an open file.
569 error_code createUniqueFile(const Twine &Model,
570 SmallVectorImpl<char> &ResultPath);
572 /// @brief Create a file in the system temporary directory.
574 /// The filename is of the form prefix-random_chars.suffix. Since the directory
575 /// is not know to the caller, Prefix and Suffix cannot have path separators.
576 /// The files are created with mode 0600.
578 /// This should be used for things like a temporary .s that is removed after
579 /// running the assembler.
580 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
582 SmallVectorImpl<char> &ResultPath);
584 /// @brief Simpler version for clients that don't want an open file.
585 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
586 SmallVectorImpl<char> &ResultPath);
588 error_code createUniqueDirectory(const Twine &Prefix,
589 SmallVectorImpl<char> &ResultPath);
594 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
595 /// report an error if the file already exists.
598 /// F_Append - When opening a file, if it already exists append to the
599 /// existing file instead of returning an error. This may not be specified
603 /// F_Binary - The file should be opened in binary mode on platforms that
604 /// make this distinction.
608 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
609 return OpenFlags(unsigned(A) | unsigned(B));
612 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
617 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
618 unsigned Mode = 0666);
620 error_code openFileForRead(const Twine &Name, int &ResultFD);
622 /// @brief Are \a path's first bytes \a magic?
624 /// @param path Input path.
625 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
626 /// @returns errc::success if result has been successfully set, otherwise a
627 /// platform specific error_code.
628 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
630 /// @brief Get \a path's first \a len bytes.
632 /// @param path Input path.
633 /// @param len Number of magic bytes to get.
634 /// @param result Set to the first \a len bytes in the file pointed to by
635 /// \a path. Or the entire file if file_size(path) < len, in which
636 /// case result.size() returns the size of the file.
637 /// @returns errc::success if result has been successfully set,
638 /// errc::value_too_large if len is larger then the file pointed to by
639 /// \a path, otherwise a platform specific error_code.
640 error_code get_magic(const Twine &path, uint32_t len,
641 SmallVectorImpl<char> &result);
643 /// @brief Identify the type of a binary file based on how magical it is.
644 file_magic identify_magic(StringRef magic);
646 /// @brief Get and identify \a path's type based on its content.
648 /// @param path Input path.
649 /// @param result Set to the type of file, or file_magic::unknown.
650 /// @returns errc::success if result has been successfully set, otherwise a
651 /// platform specific error_code.
652 error_code identify_magic(const Twine &path, file_magic &result);
654 error_code getUniqueID(const Twine Path, UniqueID &Result);
656 /// This class represents a memory mapped file. It is based on
657 /// boost::iostreams::mapped_file.
658 class mapped_file_region {
659 mapped_file_region() LLVM_DELETED_FUNCTION;
660 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
661 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
665 readonly, ///< May only access map via const_data as read only.
666 readwrite, ///< May access map via data and modify it. Written to path.
667 priv ///< May modify via data, but changes are lost on destruction.
671 /// Platform specific mapping state.
678 void *FileMappingHandle;
681 error_code init(int FD, bool CloseFD, uint64_t Offset);
684 typedef char char_type;
686 #if LLVM_HAS_RVALUE_REFERENCES
687 mapped_file_region(mapped_file_region&&);
688 mapped_file_region &operator =(mapped_file_region&&);
691 /// Construct a mapped_file_region at \a path starting at \a offset of length
692 /// \a length and with access \a mode.
694 /// \param path Path to the file to map. If it does not exist it will be
696 /// \param mode How to map the memory.
697 /// \param length Number of bytes to map in starting at \a offset. If the file
698 /// is shorter than this, it will be extended. If \a length is
699 /// 0, the entire file will be mapped.
700 /// \param offset Byte offset from the beginning of the file where the map
701 /// should begin. Must be a multiple of
702 /// mapped_file_region::alignment().
703 /// \param ec This is set to errc::success if the map was constructed
704 /// successfully. Otherwise it is set to a platform dependent error.
705 mapped_file_region(const Twine &path,
711 /// \param fd An open file descriptor to map. mapped_file_region takes
712 /// ownership if closefd is true. It must have been opended in the correct
714 mapped_file_region(int fd,
721 ~mapped_file_region();
723 mapmode flags() const;
724 uint64_t size() const;
727 /// Get a const view of the data. Modifying this memory has undefined
729 const char *const_data() const;
731 /// \returns The minimum alignment offset must be.
732 static int alignment();
735 /// @brief Memory maps the contents of a file
737 /// @param path Path to file to map.
738 /// @param file_offset Byte offset in file where mapping should begin.
739 /// @param size Byte length of range of the file to map.
740 /// @param map_writable If true, the file will be mapped in r/w such
741 /// that changes to the mapped buffer will be flushed back
742 /// to the file. If false, the file will be mapped read-only
743 /// and the buffer will be read-only.
744 /// @param result Set to the start address of the mapped buffer.
745 /// @returns errc::success if result has been successfully set, otherwise a
746 /// platform specific error_code.
747 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
748 bool map_writable, void *&result);
751 /// @brief Memory unmaps the contents of a file
753 /// @param base Pointer to the start of the buffer.
754 /// @param size Byte length of the range to unmmap.
755 /// @returns errc::success if result has been successfully set, otherwise a
756 /// platform specific error_code.
757 error_code unmap_file_pages(void *base, size_t size);
759 /// Return the path to the main executable, given the value of argv[0] from
760 /// program startup and the address of main itself. In extremis, this function
761 /// may fail and return an empty path.
762 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
768 /// directory_entry - A single entry in a directory. Caches the status either
769 /// from the result of the iteration syscall, or the first time status is
771 class directory_entry {
773 mutable file_status Status;
776 explicit directory_entry(const Twine &path, file_status st = file_status())
782 void assign(const Twine &path, file_status st = file_status()) {
787 void replace_filename(const Twine &filename, file_status st = file_status());
789 const std::string &path() const { return Path; }
790 error_code status(file_status &result) const;
792 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
793 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
794 bool operator< (const directory_entry& rhs) const;
795 bool operator<=(const directory_entry& rhs) const;
796 bool operator> (const directory_entry& rhs) const;
797 bool operator>=(const directory_entry& rhs) const;
803 error_code directory_iterator_construct(DirIterState&, StringRef);
804 error_code directory_iterator_increment(DirIterState&);
805 error_code directory_iterator_destruct(DirIterState&);
807 /// DirIterState - Keeps state for the directory_iterator. It is reference
808 /// counted in order to preserve InputIterator semantics on copy.
809 struct DirIterState : public RefCountedBase<DirIterState> {
811 : IterationHandle(0) {}
814 directory_iterator_destruct(*this);
817 intptr_t IterationHandle;
818 directory_entry CurrentEntry;
822 /// directory_iterator - Iterates through the entries in path. There is no
823 /// operator++ because we need an error_code. If it's really needed we can make
824 /// it call report_fatal_error on error.
825 class directory_iterator {
826 IntrusiveRefCntPtr<detail::DirIterState> State;
829 explicit directory_iterator(const Twine &path, error_code &ec) {
830 State = new detail::DirIterState;
831 SmallString<128> path_storage;
832 ec = detail::directory_iterator_construct(*State,
833 path.toStringRef(path_storage));
836 explicit directory_iterator(const directory_entry &de, error_code &ec) {
837 State = new detail::DirIterState;
838 ec = detail::directory_iterator_construct(*State, de.path());
841 /// Construct end iterator.
842 directory_iterator() : State(0) {}
844 // No operator++ because we need error_code.
845 directory_iterator &increment(error_code &ec) {
846 ec = directory_iterator_increment(*State);
850 const directory_entry &operator*() const { return State->CurrentEntry; }
851 const directory_entry *operator->() const { return &State->CurrentEntry; }
853 bool operator==(const directory_iterator &RHS) const {
854 if (State == RHS.State)
857 return State->CurrentEntry == directory_entry();
859 return RHS.State->CurrentEntry == directory_entry();
860 return State->CurrentEntry == RHS.State->CurrentEntry;
863 bool operator!=(const directory_iterator &RHS) const {
864 return !(*this == RHS);
866 // Other members as required by
867 // C++ Std, 24.1.1 Input iterators [input.iterators]
871 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
872 /// reference counted in order to preserve InputIterator semantics on copy.
873 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
876 , HasNoPushRequest(false) {}
878 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
880 bool HasNoPushRequest;
884 /// recursive_directory_iterator - Same as directory_iterator except for it
885 /// recurses down into child directories.
886 class recursive_directory_iterator {
887 IntrusiveRefCntPtr<detail::RecDirIterState> State;
890 recursive_directory_iterator() {}
891 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
892 : State(new detail::RecDirIterState) {
893 State->Stack.push(directory_iterator(path, ec));
894 if (State->Stack.top() == directory_iterator())
897 // No operator++ because we need error_code.
898 recursive_directory_iterator &increment(error_code &ec) {
899 const directory_iterator end_itr;
901 if (State->HasNoPushRequest)
902 State->HasNoPushRequest = false;
905 if ((ec = State->Stack.top()->status(st))) return *this;
906 if (is_directory(st)) {
907 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
908 if (ec) return *this;
909 if (State->Stack.top() != end_itr) {
917 while (!State->Stack.empty()
918 && State->Stack.top().increment(ec) == end_itr) {
923 // Check if we are done. If so, create an end iterator.
924 if (State->Stack.empty())
930 const directory_entry &operator*() const { return *State->Stack.top(); }
931 const directory_entry *operator->() const { return &*State->Stack.top(); }
934 /// Gets the current level. Starting path is at level 0.
935 int level() const { return State->Level; }
937 /// Returns true if no_push has been called for this directory_entry.
938 bool no_push_request() const { return State->HasNoPushRequest; }
941 /// Goes up one level if Level > 0.
943 assert(State && "Cannot pop an end iterator!");
944 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
946 const directory_iterator end_itr;
950 report_fatal_error("Error incrementing directory iterator.");
953 } while (!State->Stack.empty()
954 && State->Stack.top().increment(ec) == end_itr);
956 // Check if we are done. If so, create an end iterator.
957 if (State->Stack.empty())
961 /// Does not go down into the current directory_entry.
962 void no_push() { State->HasNoPushRequest = true; }
964 bool operator==(const recursive_directory_iterator &RHS) const {
965 return State == RHS.State;
968 bool operator!=(const recursive_directory_iterator &RHS) const {
969 return !(*this == RHS);
971 // Other members as required by
972 // C++ Std, 24.1.1 Input iterators [input.iterators]
977 } // end namespace fs
978 } // end namespace sys
979 } // end namespace llvm