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 Create a symbolic link from \a from to \a to.
313 /// @param to The path to symbolically link to.
314 /// @param from The path to symbolically link from. This is created.
315 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
316 /// otherwise a platform specific error_code.
317 error_code create_symlink(const Twine &to, const Twine &from);
319 /// @brief Get the current path.
321 /// @param result Holds the current path on return.
322 /// @returns errc::success if the current path has been stored in result,
323 /// otherwise a platform specific error_code.
324 error_code current_path(SmallVectorImpl<char> &result);
326 /// @brief Remove path. Equivalent to POSIX remove().
328 /// @param path Input path.
329 /// @param existed Set to true if \a path existed, false if it did not.
330 /// undefined otherwise.
331 /// @returns errc::success if path has been removed and existed has been
332 /// successfully set, otherwise a platform specific error_code.
333 error_code remove(const Twine &path, bool &existed);
335 /// @brief Convenience function for clients that don't need to know if the file
337 inline error_code remove(const Twine &Path) {
339 return remove(Path, Existed);
342 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
344 /// @param from The path to rename from.
345 /// @param to The path to rename to. This is created.
346 error_code rename(const Twine &from, const Twine &to);
348 /// @brief Resize path to size. File is resized as if by POSIX truncate().
350 /// @param path Input path.
351 /// @param size Size to resize to.
352 /// @returns errc::success if \a path has been resized to \a size, otherwise a
353 /// platform specific error_code.
354 error_code resize_file(const Twine &path, uint64_t size);
357 /// @name Physical Observers
360 /// @brief Does file exist?
362 /// @param status A file_status previously returned from stat.
363 /// @returns True if the file represented by status exists, false if it does
365 bool exists(file_status status);
367 /// @brief Does file exist?
369 /// @param path Input path.
370 /// @param result Set to true if the file represented by status exists, false if
371 /// it does not. Undefined otherwise.
372 /// @returns errc::success if result has been successfully set, otherwise a
373 /// platform specific error_code.
374 error_code exists(const Twine &path, bool &result);
376 /// @brief Simpler version of exists for clients that don't need to
377 /// differentiate between an error and false.
378 inline bool exists(const Twine &path) {
380 return !exists(path, result) && result;
383 /// @brief Can we execute this file?
385 /// @param Path Input path.
386 /// @returns True if we can execute it, false otherwise.
387 bool can_execute(const Twine &Path);
389 /// @brief Can we write this file?
391 /// @param Path Input path.
392 /// @returns True if we can write to it, false otherwise.
393 bool can_write(const Twine &Path);
395 /// @brief Do file_status's represent the same thing?
397 /// @param A Input file_status.
398 /// @param B Input file_status.
400 /// assert(status_known(A) || status_known(B));
402 /// @returns True if A and B both represent the same file system entity, false
404 bool equivalent(file_status A, file_status B);
406 /// @brief Do paths represent the same thing?
408 /// assert(status_known(A) || status_known(B));
410 /// @param A Input path A.
411 /// @param B Input path B.
412 /// @param result Set to true if stat(A) and stat(B) have the same device and
413 /// inode (or equivalent).
414 /// @returns errc::success if result has been successfully set, otherwise a
415 /// platform specific error_code.
416 error_code equivalent(const Twine &A, const Twine &B, bool &result);
418 /// @brief Simpler version of equivalent for clients that don't need to
419 /// differentiate between an error and false.
420 inline bool equivalent(const Twine &A, const Twine &B) {
422 return !equivalent(A, B, result) && result;
425 /// @brief Does status represent a directory?
427 /// @param status A file_status previously returned from status.
428 /// @returns status.type() == file_type::directory_file.
429 bool is_directory(file_status status);
431 /// @brief Is path a directory?
433 /// @param path Input path.
434 /// @param result Set to true if \a path is a directory, false if it is not.
435 /// Undefined otherwise.
436 /// @returns errc::success if result has been successfully set, otherwise a
437 /// platform specific error_code.
438 error_code is_directory(const Twine &path, bool &result);
440 /// @brief Simpler version of is_directory for clients that don't need to
441 /// differentiate between an error and false.
442 inline bool is_directory(const Twine &Path) {
444 return !is_directory(Path, Result) && Result;
447 /// @brief Does status represent a regular file?
449 /// @param status A file_status previously returned from status.
450 /// @returns status_known(status) && status.type() == file_type::regular_file.
451 bool is_regular_file(file_status status);
453 /// @brief Is path a regular file?
455 /// @param path Input path.
456 /// @param result Set to true if \a path is a regular file, false if it is not.
457 /// Undefined otherwise.
458 /// @returns errc::success if result has been successfully set, otherwise a
459 /// platform specific error_code.
460 error_code is_regular_file(const Twine &path, bool &result);
462 /// @brief Simpler version of is_regular_file for clients that don't need to
463 /// differentiate between an error and false.
464 inline bool is_regular_file(const Twine &Path) {
466 if (is_regular_file(Path, Result))
471 /// @brief Does this status represent something that exists but is not a
472 /// directory, regular file, or symlink?
474 /// @param status A file_status previously returned from status.
475 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
477 bool is_other(file_status status);
479 /// @brief Is path something that exists but is not a directory,
480 /// regular file, or symlink?
482 /// @param path Input path.
483 /// @param result Set to true if \a path exists, but is not a directory, regular
484 /// file, or a symlink, false if it does not. Undefined otherwise.
485 /// @returns errc::success if result has been successfully set, otherwise a
486 /// platform specific error_code.
487 error_code is_other(const Twine &path, bool &result);
489 /// @brief Does status represent a symlink?
491 /// @param status A file_status previously returned from stat.
492 /// @returns status.type() == symlink_file.
493 bool is_symlink(file_status status);
495 /// @brief Is path a symlink?
497 /// @param path Input path.
498 /// @param result Set to true if \a path is a symlink, false if it is not.
499 /// Undefined otherwise.
500 /// @returns errc::success if result has been successfully set, otherwise a
501 /// platform specific error_code.
502 error_code is_symlink(const Twine &path, bool &result);
504 /// @brief Get file status as if by POSIX stat().
506 /// @param path Input path.
507 /// @param result Set to the file status.
508 /// @returns errc::success if result has been successfully set, otherwise a
509 /// platform specific error_code.
510 error_code status(const Twine &path, file_status &result);
512 /// @brief A version for when a file descriptor is already available.
513 error_code status(int FD, file_status &Result);
515 /// @brief Get file size.
517 /// @param Path Input path.
518 /// @param Result Set to the size of the file in \a Path.
519 /// @returns errc::success if result has been successfully set, otherwise a
520 /// platform specific error_code.
521 inline error_code file_size(const Twine &Path, uint64_t &Result) {
523 error_code EC = status(Path, Status);
526 Result = Status.getSize();
527 return error_code::success();
530 /// @brief Set the file modification and access time.
532 /// @returns errc::success if the file times were successfully set, otherwise a
533 /// platform specific error_code or errc::not_supported on platforms
534 /// where the functionality isn't available.
535 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
537 /// @brief Is status available?
539 /// @param s Input file status.
540 /// @returns True if status() != status_error.
541 bool status_known(file_status s);
543 /// @brief Is status available?
545 /// @param path Input path.
546 /// @param result Set to true if status() != status_error.
547 /// @returns errc::success if result has been successfully set, otherwise a
548 /// platform specific error_code.
549 error_code status_known(const Twine &path, bool &result);
551 /// @brief Create a uniquely named file.
553 /// Generates a unique path suitable for a temporary file and then opens it as a
554 /// file. The name is based on \a model with '%' replaced by a random char in
555 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
556 /// directory will be prepended.
558 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
560 /// This is an atomic operation. Either the file is created and opened, or the
561 /// file system is left untouched.
563 /// The intendend use is for files that are to be kept, possibly after
564 /// renaming them. For example, when running 'clang -c foo.o', the file can
565 /// be first created as foo-abc123.o and then renamed.
567 /// @param Model Name to base unique path off of.
568 /// @param ResultFD Set to the opened file's file descriptor.
569 /// @param ResultPath Set to the opened file's absolute path.
570 /// @returns errc::success if Result{FD,Path} have been successfully set,
571 /// otherwise a platform specific error_code.
572 error_code createUniqueFile(const Twine &Model, int &ResultFD,
573 SmallVectorImpl<char> &ResultPath,
574 unsigned Mode = all_read | all_write);
576 /// @brief Simpler version for clients that don't want an open file.
577 error_code createUniqueFile(const Twine &Model,
578 SmallVectorImpl<char> &ResultPath);
580 /// @brief Create a file in the system temporary directory.
582 /// The filename is of the form prefix-random_chars.suffix. Since the directory
583 /// is not know to the caller, Prefix and Suffix cannot have path separators.
584 /// The files are created with mode 0600.
586 /// This should be used for things like a temporary .s that is removed after
587 /// running the assembler.
588 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
590 SmallVectorImpl<char> &ResultPath);
592 /// @brief Simpler version for clients that don't want an open file.
593 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
594 SmallVectorImpl<char> &ResultPath);
596 error_code createUniqueDirectory(const Twine &Prefix,
597 SmallVectorImpl<char> &ResultPath);
602 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
603 /// report an error if the file already exists.
606 /// F_Append - When opening a file, if it already exists append to the
607 /// existing file instead of returning an error. This may not be specified
611 /// F_Binary - The file should be opened in binary mode on platforms that
612 /// make this distinction.
616 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
617 return OpenFlags(unsigned(A) | unsigned(B));
620 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
625 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
626 unsigned Mode = 0666);
628 error_code openFileForRead(const Twine &Name, int &ResultFD);
630 /// @brief Are \a path's first bytes \a magic?
632 /// @param path Input path.
633 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
634 /// @returns errc::success if result has been successfully set, otherwise a
635 /// platform specific error_code.
636 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
638 /// @brief Get \a path's first \a len bytes.
640 /// @param path Input path.
641 /// @param len Number of magic bytes to get.
642 /// @param result Set to the first \a len bytes in the file pointed to by
643 /// \a path. Or the entire file if file_size(path) < len, in which
644 /// case result.size() returns the size of the file.
645 /// @returns errc::success if result has been successfully set,
646 /// errc::value_too_large if len is larger then the file pointed to by
647 /// \a path, otherwise a platform specific error_code.
648 error_code get_magic(const Twine &path, uint32_t len,
649 SmallVectorImpl<char> &result);
651 /// @brief Identify the type of a binary file based on how magical it is.
652 file_magic identify_magic(StringRef magic);
654 /// @brief Get and identify \a path's type based on its content.
656 /// @param path Input path.
657 /// @param result Set to the type of file, or file_magic::unknown.
658 /// @returns errc::success if result has been successfully set, otherwise a
659 /// platform specific error_code.
660 error_code identify_magic(const Twine &path, file_magic &result);
662 error_code getUniqueID(const Twine Path, UniqueID &Result);
664 /// This class represents a memory mapped file. It is based on
665 /// boost::iostreams::mapped_file.
666 class mapped_file_region {
667 mapped_file_region() LLVM_DELETED_FUNCTION;
668 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
669 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
673 readonly, ///< May only access map via const_data as read only.
674 readwrite, ///< May access map via data and modify it. Written to path.
675 priv ///< May modify via data, but changes are lost on destruction.
679 /// Platform specific mapping state.
686 void *FileMappingHandle;
689 error_code init(int FD, bool CloseFD, uint64_t Offset);
692 typedef char char_type;
694 #if LLVM_HAS_RVALUE_REFERENCES
695 mapped_file_region(mapped_file_region&&);
696 mapped_file_region &operator =(mapped_file_region&&);
699 /// Construct a mapped_file_region at \a path starting at \a offset of length
700 /// \a length and with access \a mode.
702 /// \param path Path to the file to map. If it does not exist it will be
704 /// \param mode How to map the memory.
705 /// \param length Number of bytes to map in starting at \a offset. If the file
706 /// is shorter than this, it will be extended. If \a length is
707 /// 0, the entire file will be mapped.
708 /// \param offset Byte offset from the beginning of the file where the map
709 /// should begin. Must be a multiple of
710 /// mapped_file_region::alignment().
711 /// \param ec This is set to errc::success if the map was constructed
712 /// successfully. Otherwise it is set to a platform dependent error.
713 mapped_file_region(const Twine &path,
719 /// \param fd An open file descriptor to map. mapped_file_region takes
720 /// ownership if closefd is true. It must have been opended in the correct
722 mapped_file_region(int fd,
729 ~mapped_file_region();
731 mapmode flags() const;
732 uint64_t size() const;
735 /// Get a const view of the data. Modifying this memory has undefined
737 const char *const_data() const;
739 /// \returns The minimum alignment offset must be.
740 static int alignment();
743 /// @brief Memory maps the contents of a file
745 /// @param path Path to file to map.
746 /// @param file_offset Byte offset in file where mapping should begin.
747 /// @param size Byte length of range of the file to map.
748 /// @param map_writable If true, the file will be mapped in r/w such
749 /// that changes to the mapped buffer will be flushed back
750 /// to the file. If false, the file will be mapped read-only
751 /// and the buffer will be read-only.
752 /// @param result Set to the start address of the mapped buffer.
753 /// @returns errc::success if result has been successfully set, otherwise a
754 /// platform specific error_code.
755 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
756 bool map_writable, void *&result);
759 /// @brief Memory unmaps the contents of a file
761 /// @param base Pointer to the start of the buffer.
762 /// @param size Byte length of the range to unmmap.
763 /// @returns errc::success if result has been successfully set, otherwise a
764 /// platform specific error_code.
765 error_code unmap_file_pages(void *base, size_t size);
767 /// Return the path to the main executable, given the value of argv[0] from
768 /// program startup and the address of main itself. In extremis, this function
769 /// may fail and return an empty path.
770 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
776 /// directory_entry - A single entry in a directory. Caches the status either
777 /// from the result of the iteration syscall, or the first time status is
779 class directory_entry {
781 mutable file_status Status;
784 explicit directory_entry(const Twine &path, file_status st = file_status())
790 void assign(const Twine &path, file_status st = file_status()) {
795 void replace_filename(const Twine &filename, file_status st = file_status());
797 const std::string &path() const { return Path; }
798 error_code status(file_status &result) const;
800 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
801 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
802 bool operator< (const directory_entry& rhs) const;
803 bool operator<=(const directory_entry& rhs) const;
804 bool operator> (const directory_entry& rhs) const;
805 bool operator>=(const directory_entry& rhs) const;
811 error_code directory_iterator_construct(DirIterState&, StringRef);
812 error_code directory_iterator_increment(DirIterState&);
813 error_code directory_iterator_destruct(DirIterState&);
815 /// DirIterState - Keeps state for the directory_iterator. It is reference
816 /// counted in order to preserve InputIterator semantics on copy.
817 struct DirIterState : public RefCountedBase<DirIterState> {
819 : IterationHandle(0) {}
822 directory_iterator_destruct(*this);
825 intptr_t IterationHandle;
826 directory_entry CurrentEntry;
830 /// directory_iterator - Iterates through the entries in path. There is no
831 /// operator++ because we need an error_code. If it's really needed we can make
832 /// it call report_fatal_error on error.
833 class directory_iterator {
834 IntrusiveRefCntPtr<detail::DirIterState> State;
837 explicit directory_iterator(const Twine &path, error_code &ec) {
838 State = new detail::DirIterState;
839 SmallString<128> path_storage;
840 ec = detail::directory_iterator_construct(*State,
841 path.toStringRef(path_storage));
844 explicit directory_iterator(const directory_entry &de, error_code &ec) {
845 State = new detail::DirIterState;
846 ec = detail::directory_iterator_construct(*State, de.path());
849 /// Construct end iterator.
850 directory_iterator() : State(0) {}
852 // No operator++ because we need error_code.
853 directory_iterator &increment(error_code &ec) {
854 ec = directory_iterator_increment(*State);
858 const directory_entry &operator*() const { return State->CurrentEntry; }
859 const directory_entry *operator->() const { return &State->CurrentEntry; }
861 bool operator==(const directory_iterator &RHS) const {
862 if (State == RHS.State)
865 return State->CurrentEntry == directory_entry();
867 return RHS.State->CurrentEntry == directory_entry();
868 return State->CurrentEntry == RHS.State->CurrentEntry;
871 bool operator!=(const directory_iterator &RHS) const {
872 return !(*this == RHS);
874 // Other members as required by
875 // C++ Std, 24.1.1 Input iterators [input.iterators]
879 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
880 /// reference counted in order to preserve InputIterator semantics on copy.
881 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
884 , HasNoPushRequest(false) {}
886 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
888 bool HasNoPushRequest;
892 /// recursive_directory_iterator - Same as directory_iterator except for it
893 /// recurses down into child directories.
894 class recursive_directory_iterator {
895 IntrusiveRefCntPtr<detail::RecDirIterState> State;
898 recursive_directory_iterator() {}
899 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
900 : State(new detail::RecDirIterState) {
901 State->Stack.push(directory_iterator(path, ec));
902 if (State->Stack.top() == directory_iterator())
905 // No operator++ because we need error_code.
906 recursive_directory_iterator &increment(error_code &ec) {
907 const directory_iterator end_itr;
909 if (State->HasNoPushRequest)
910 State->HasNoPushRequest = false;
913 if ((ec = State->Stack.top()->status(st))) return *this;
914 if (is_directory(st)) {
915 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
916 if (ec) return *this;
917 if (State->Stack.top() != end_itr) {
925 while (!State->Stack.empty()
926 && State->Stack.top().increment(ec) == end_itr) {
931 // Check if we are done. If so, create an end iterator.
932 if (State->Stack.empty())
938 const directory_entry &operator*() const { return *State->Stack.top(); }
939 const directory_entry *operator->() const { return &*State->Stack.top(); }
942 /// Gets the current level. Starting path is at level 0.
943 int level() const { return State->Level; }
945 /// Returns true if no_push has been called for this directory_entry.
946 bool no_push_request() const { return State->HasNoPushRequest; }
949 /// Goes up one level if Level > 0.
951 assert(State && "Cannot pop an end iterator!");
952 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
954 const directory_iterator end_itr;
958 report_fatal_error("Error incrementing directory iterator.");
961 } while (!State->Stack.empty()
962 && State->Stack.top().increment(ec) == end_itr);
964 // Check if we are done. If so, create an end iterator.
965 if (State->Stack.empty())
969 /// Does not go down into the current directory_entry.
970 void no_push() { State->HasNoPushRequest = true; }
972 bool operator==(const recursive_directory_iterator &RHS) const {
973 return State == RHS.State;
976 bool operator!=(const recursive_directory_iterator &RHS) const {
977 return !(*this == RHS);
979 // Other members as required by
980 // C++ Std, 24.1.1 Input iterators [input.iterators]
985 } // end namespace fs
986 } // end namespace sys
987 } // end namespace llvm