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 /// file_type - An "enum class" enumeration for the file system's view of the
68 file_type(_ v) : v_(v) {}
69 explicit file_type(int v) : v_(_(v)) {}
70 operator int() const {return v_;}
76 /// space_info - Self explanatory.
88 owner_all = owner_read | owner_write | owner_exe,
92 group_all = group_read | group_write | group_exe,
96 others_all = others_read | others_write | others_exe,
97 all_read = owner_read | group_read | others_read,
98 all_write = owner_write | group_write | others_write,
99 all_exe = owner_exe | group_exe | others_exe,
100 all_all = owner_all | group_all | others_all,
101 set_uid_on_exe = 04000,
102 set_gid_on_exe = 02000,
104 perms_not_known = 0xFFFF
107 // Helper functions so that you can use & and | to manipulate perms bits:
108 inline perms operator|(perms l , perms r) {
109 return static_cast<perms>(
110 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
112 inline perms operator&(perms l , perms r) {
113 return static_cast<perms>(
114 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
116 inline perms &operator|=(perms &l, perms r) {
120 inline perms &operator&=(perms &l, perms r) {
124 inline perms operator~(perms x) {
125 return static_cast<perms>(~static_cast<unsigned short>(x));
134 UniqueID(uint64_t Device, uint64_t File) : Device(Device), File(File) {}
135 bool operator==(const UniqueID &Other) const {
136 return Device == Other.Device && File == Other.File;
138 bool operator!=(const UniqueID &Other) const { return !(*this == Other); }
139 bool operator<(const UniqueID &Other) const {
140 return Device < Other.Device ||
141 (Device == Other.Device && File < Other.File);
143 uint64_t getDevice() const { return Device; }
144 uint64_t getFile() const { return File; }
147 /// file_status - Represents the result of a call to stat and friends. It has
148 /// a platform specific member to store the result.
151 #if defined(LLVM_ON_UNIX)
158 #elif defined (LLVM_ON_WIN32)
159 uint32_t LastWriteTimeHigh;
160 uint32_t LastWriteTimeLow;
161 uint32_t VolumeSerialNumber;
162 uint32_t FileSizeHigh;
163 uint32_t FileSizeLow;
164 uint32_t FileIndexHigh;
165 uint32_t FileIndexLow;
167 friend bool equivalent(file_status A, file_status B);
171 file_status() : Type(file_type::status_error) {}
172 file_status(file_type Type) : Type(Type) {}
174 #if defined(LLVM_ON_UNIX)
175 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
176 uid_t UID, gid_t GID, off_t Size)
177 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
178 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
179 #elif defined(LLVM_ON_WIN32)
180 file_status(file_type Type, uint32_t LastWriteTimeHigh,
181 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
182 uint32_t FileSizeHigh, uint32_t FileSizeLow,
183 uint32_t FileIndexHigh, uint32_t FileIndexLow)
184 : LastWriteTimeHigh(LastWriteTimeHigh),
185 LastWriteTimeLow(LastWriteTimeLow),
186 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
187 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
188 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
192 file_type type() const { return Type; }
193 perms permissions() const { return Perms; }
194 TimeValue getLastModificationTime() const;
195 UniqueID getUniqueID() const;
197 #if defined(LLVM_ON_UNIX)
198 uint32_t getUser() const { return fs_st_uid; }
199 uint32_t getGroup() const { return fs_st_gid; }
200 uint64_t getSize() const { return fs_st_size; }
201 #elif defined (LLVM_ON_WIN32)
202 uint32_t getUser() const {
203 return 9999; // Not applicable to Windows, so...
205 uint32_t getGroup() const {
206 return 9999; // Not applicable to Windows, so...
208 uint64_t getSize() const {
209 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
214 void type(file_type v) { Type = v; }
215 void permissions(perms p) { Perms = p; }
218 /// file_magic - An "enum class" enumeration of file types based on magic (the first
219 /// N bytes of the file).
222 unknown = 0, ///< Unrecognized file
223 bitcode, ///< Bitcode file
224 archive, ///< ar style archive file
225 elf_relocatable, ///< ELF Relocatable object file
226 elf_executable, ///< ELF Executable image
227 elf_shared_object, ///< ELF dynamically linked shared lib
228 elf_core, ///< ELF core image
229 macho_object, ///< Mach-O Object file
230 macho_executable, ///< Mach-O Executable
231 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
232 macho_core, ///< Mach-O Core File
233 macho_preload_executable, ///< Mach-O Preloaded Executable
234 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
235 macho_dynamic_linker, ///< The Mach-O dynamic linker
236 macho_bundle, ///< Mach-O Bundle file
237 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
238 macho_dsym_companion, ///< Mach-O dSYM companion file
239 macho_universal_binary, ///< Mach-O universal binary
240 coff_object, ///< COFF object file
241 coff_import_library, ///< COFF import library
242 pecoff_executable, ///< PECOFF executable file
243 windows_resource ///< Windows compiled resource file (.rc)
246 bool is_object() const {
247 return V == unknown ? false : true;
250 file_magic() : V(unknown) {}
251 file_magic(Impl V) : V(V) {}
252 operator Impl() const { return V; }
259 /// @name Physical Operators
262 /// @brief Make \a path an absolute path.
264 /// Makes \a path absolute using the current directory if it is not already. An
265 /// empty \a path will result in the current directory.
267 /// /absolute/path => /absolute/path
268 /// relative/../path => <current-directory>/relative/../path
270 /// @param path A path that is modified to be an absolute path.
271 /// @returns errc::success if \a path has been made absolute, otherwise a
272 /// platform specific error_code.
273 error_code make_absolute(SmallVectorImpl<char> &path);
275 /// @brief Create all the non-existent directories in path.
277 /// @param path Directories to create.
278 /// @param existed Set to true if \a path already existed, false otherwise.
279 /// @returns errc::success if is_directory(path) and existed have been set,
280 /// otherwise a platform specific error_code.
281 error_code create_directories(const Twine &path, bool &existed);
283 /// @brief Convenience function for clients that don't need to know if the
284 /// directory existed or not.
285 inline error_code create_directories(const Twine &Path) {
287 return create_directories(Path, Existed);
290 /// @brief Create the directory in path.
292 /// @param path Directory to create.
293 /// @param existed Set to true if \a path already existed, false otherwise.
294 /// @returns errc::success if is_directory(path) and existed have been set,
295 /// otherwise a platform specific error_code.
296 error_code create_directory(const Twine &path, bool &existed);
298 /// @brief Convenience function for clients that don't need to know if the
299 /// directory existed or not.
300 inline error_code create_directory(const Twine &Path) {
302 return create_directory(Path, Existed);
305 /// @brief Create a hard link from \a from to \a to.
307 /// @param to The path to hard link to.
308 /// @param from The path to hard link from. This is created.
309 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
310 /// , otherwise a platform specific error_code.
311 error_code create_hard_link(const Twine &to, const Twine &from);
313 /// @brief Create a symbolic link from \a from to \a to.
315 /// @param to The path to symbolically link to.
316 /// @param from The path to symbolically link from. This is created.
317 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
318 /// otherwise a platform specific error_code.
319 error_code create_symlink(const Twine &to, const Twine &from);
321 /// @brief Get the current path.
323 /// @param result Holds the current path on return.
324 /// @returns errc::success if the current path has been stored in result,
325 /// otherwise a platform specific error_code.
326 error_code current_path(SmallVectorImpl<char> &result);
328 /// @brief Remove path. Equivalent to POSIX remove().
330 /// @param path Input path.
331 /// @param existed Set to true if \a path existed, false if it did not.
332 /// undefined otherwise.
333 /// @returns errc::success if path has been removed and existed has been
334 /// successfully set, otherwise a platform specific error_code.
335 error_code remove(const Twine &path, bool &existed);
337 /// @brief Convenience function for clients that don't need to know if the file
339 inline error_code remove(const Twine &Path) {
341 return remove(Path, Existed);
344 /// @brief Recursively remove all files below \a path, then \a path. Files are
345 /// removed as if by POSIX remove().
347 /// @param path Input path.
348 /// @param num_removed Number of files removed.
349 /// @returns errc::success if path has been removed and num_removed has been
350 /// successfully set, otherwise a platform specific error_code.
351 error_code remove_all(const Twine &path, uint32_t &num_removed);
353 /// @brief Convenience function for clients that don't need to know how many
354 /// files were removed.
355 inline error_code remove_all(const Twine &Path) {
357 return remove_all(Path, Removed);
360 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
362 /// @param from The path to rename from.
363 /// @param to The path to rename to. This is created.
364 error_code rename(const Twine &from, const Twine &to);
366 /// @brief Resize path to size. File is resized as if by POSIX truncate().
368 /// @param path Input path.
369 /// @param size Size to resize to.
370 /// @returns errc::success if \a path has been resized to \a size, otherwise a
371 /// platform specific error_code.
372 error_code resize_file(const Twine &path, uint64_t size);
375 /// @name Physical Observers
378 /// @brief Does file exist?
380 /// @param status A file_status previously returned from stat.
381 /// @returns True if the file represented by status exists, false if it does
383 bool exists(file_status status);
385 /// @brief Does file exist?
387 /// @param path Input path.
388 /// @param result Set to true if the file represented by status exists, false if
389 /// it does not. Undefined otherwise.
390 /// @returns errc::success if result has been successfully set, otherwise a
391 /// platform specific error_code.
392 error_code exists(const Twine &path, bool &result);
394 /// @brief Simpler version of exists for clients that don't need to
395 /// differentiate between an error and false.
396 inline bool exists(const Twine &path) {
398 return !exists(path, result) && result;
401 /// @brief Can we execute this file?
403 /// @param Path Input path.
404 /// @returns True if we can execute it, false otherwise.
405 bool can_execute(const Twine &Path);
407 /// @brief Can we write this file?
409 /// @param Path Input path.
410 /// @returns True if we can write to it, false otherwise.
411 bool can_write(const Twine &Path);
413 /// @brief Do file_status's represent the same thing?
415 /// @param A Input file_status.
416 /// @param B Input file_status.
418 /// assert(status_known(A) || status_known(B));
420 /// @returns True if A and B both represent the same file system entity, false
422 bool equivalent(file_status A, file_status B);
424 /// @brief Do paths represent the same thing?
426 /// assert(status_known(A) || status_known(B));
428 /// @param A Input path A.
429 /// @param B Input path B.
430 /// @param result Set to true if stat(A) and stat(B) have the same device and
431 /// inode (or equivalent).
432 /// @returns errc::success if result has been successfully set, otherwise a
433 /// platform specific error_code.
434 error_code equivalent(const Twine &A, const Twine &B, bool &result);
436 /// @brief Simpler version of equivalent for clients that don't need to
437 /// differentiate between an error and false.
438 inline bool equivalent(const Twine &A, const Twine &B) {
440 return !equivalent(A, B, result) && result;
443 /// @brief Does status represent a directory?
445 /// @param status A file_status previously returned from status.
446 /// @returns status.type() == file_type::directory_file.
447 bool is_directory(file_status status);
449 /// @brief Is path a directory?
451 /// @param path Input path.
452 /// @param result Set to true if \a path is a directory, false if it is not.
453 /// Undefined otherwise.
454 /// @returns errc::success if result has been successfully set, otherwise a
455 /// platform specific error_code.
456 error_code is_directory(const Twine &path, bool &result);
458 /// @brief Simpler version of is_directory for clients that don't need to
459 /// differentiate between an error and false.
460 inline bool is_directory(const Twine &Path) {
462 return !is_directory(Path, Result) && Result;
465 /// @brief Does status represent a regular file?
467 /// @param status A file_status previously returned from status.
468 /// @returns status_known(status) && status.type() == file_type::regular_file.
469 bool is_regular_file(file_status status);
471 /// @brief Is path a regular file?
473 /// @param path Input path.
474 /// @param result Set to true if \a path is a regular file, false if it is not.
475 /// Undefined otherwise.
476 /// @returns errc::success if result has been successfully set, otherwise a
477 /// platform specific error_code.
478 error_code is_regular_file(const Twine &path, bool &result);
480 /// @brief Simpler version of is_regular_file for clients that don't need to
481 /// differentiate between an error and false.
482 inline bool is_regular_file(const Twine &Path) {
484 if (is_regular_file(Path, Result))
489 /// @brief Does this status represent something that exists but is not a
490 /// directory, regular file, or symlink?
492 /// @param status A file_status previously returned from status.
493 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
495 bool is_other(file_status status);
497 /// @brief Is path something that exists but is not a directory,
498 /// regular file, or symlink?
500 /// @param path Input path.
501 /// @param result Set to true if \a path exists, but is not a directory, regular
502 /// file, or a symlink, false if it does not. Undefined otherwise.
503 /// @returns errc::success if result has been successfully set, otherwise a
504 /// platform specific error_code.
505 error_code is_other(const Twine &path, bool &result);
507 /// @brief Does status represent a symlink?
509 /// @param status A file_status previously returned from stat.
510 /// @returns status.type() == symlink_file.
511 bool is_symlink(file_status status);
513 /// @brief Is path a symlink?
515 /// @param path Input path.
516 /// @param result Set to true if \a path is a symlink, false if it is not.
517 /// Undefined otherwise.
518 /// @returns errc::success if result has been successfully set, otherwise a
519 /// platform specific error_code.
520 error_code is_symlink(const Twine &path, bool &result);
522 /// @brief Get file status as if by POSIX stat().
524 /// @param path Input path.
525 /// @param result Set to the file status.
526 /// @returns errc::success if result has been successfully set, otherwise a
527 /// platform specific error_code.
528 error_code status(const Twine &path, file_status &result);
530 /// @brief A version for when a file descriptor is already available.
531 error_code status(int FD, file_status &Result);
533 /// @brief Get file size.
535 /// @param Path Input path.
536 /// @param Result Set to the size of the file in \a Path.
537 /// @returns errc::success if result has been successfully set, otherwise a
538 /// platform specific error_code.
539 inline error_code file_size(const Twine &Path, uint64_t &Result) {
541 error_code EC = status(Path, Status);
544 Result = Status.getSize();
545 return error_code::success();
548 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
550 /// @brief Is status available?
552 /// @param s Input file status.
553 /// @returns True if status() != status_error.
554 bool status_known(file_status s);
556 /// @brief Is status available?
558 /// @param path Input path.
559 /// @param result Set to true if status() != status_error.
560 /// @returns errc::success if result has been successfully set, otherwise a
561 /// platform specific error_code.
562 error_code status_known(const Twine &path, bool &result);
564 /// @brief Create a uniquely named file.
566 /// Generates a unique path suitable for a temporary file and then opens it as a
567 /// file. The name is based on \a model with '%' replaced by a random char in
568 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
569 /// directory will be prepended.
571 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
573 /// This is an atomic operation. Either the file is created and opened, or the
574 /// file system is left untouched.
576 /// The intendend use is for files that are to be kept, possibly after
577 /// renaming them. For example, when running 'clang -c foo.o', the file can
578 /// be first created as foo-abc123.o and then renamed.
580 /// @param Model Name to base unique path off of.
581 /// @param ResultFD Set to the opened file's file descriptor.
582 /// @param ResultPath Set to the opened file's absolute path.
583 /// @returns errc::success if Result{FD,Path} have been successfully set,
584 /// otherwise a platform specific error_code.
585 error_code createUniqueFile(const Twine &Model, int &ResultFD,
586 SmallVectorImpl<char> &ResultPath,
587 unsigned Mode = all_read | all_write);
589 /// @brief Simpler version for clients that don't want an open file.
590 error_code createUniqueFile(const Twine &Model,
591 SmallVectorImpl<char> &ResultPath);
593 /// @brief Create a file in the system temporary directory.
595 /// The filename is of the form prefix-random_chars.suffix. Since the directory
596 /// is not know to the caller, Prefix and Suffix cannot have path separators.
597 /// The files are created with mode 0600.
599 /// This should be used for things like a temporary .s that is removed after
600 /// running the assembler.
601 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
603 SmallVectorImpl<char> &ResultPath);
605 /// @brief Simpler version for clients that don't want an open file.
606 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
607 SmallVectorImpl<char> &ResultPath);
609 error_code createUniqueDirectory(const Twine &Prefix,
610 SmallVectorImpl<char> &ResultPath);
615 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
616 /// report an error if the file already exists.
619 /// F_Append - When opening a file, if it already exists append to the
620 /// existing file instead of returning an error. This may not be specified
624 /// F_Binary - The file should be opened in binary mode on platforms that
625 /// make this distinction.
629 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
630 return OpenFlags(unsigned(A) | unsigned(B));
633 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
638 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
639 unsigned Mode = 0666);
641 error_code openFileForRead(const Twine &Name, int &ResultFD);
643 /// @brief Are \a path's first bytes \a magic?
645 /// @param path Input path.
646 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
647 /// @returns errc::success if result has been successfully set, otherwise a
648 /// platform specific error_code.
649 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
651 /// @brief Get \a path's first \a len bytes.
653 /// @param path Input path.
654 /// @param len Number of magic bytes to get.
655 /// @param result Set to the first \a len bytes in the file pointed to by
656 /// \a path. Or the entire file if file_size(path) < len, in which
657 /// case result.size() returns the size of the file.
658 /// @returns errc::success if result has been successfully set,
659 /// errc::value_too_large if len is larger then the file pointed to by
660 /// \a path, otherwise a platform specific error_code.
661 error_code get_magic(const Twine &path, uint32_t len,
662 SmallVectorImpl<char> &result);
664 /// @brief Identify the type of a binary file based on how magical it is.
665 file_magic identify_magic(StringRef magic);
667 /// @brief Get and identify \a path's type based on its content.
669 /// @param path Input path.
670 /// @param result Set to the type of file, or file_magic::unknown.
671 /// @returns errc::success if result has been successfully set, otherwise a
672 /// platform specific error_code.
673 error_code identify_magic(const Twine &path, file_magic &result);
675 error_code getUniqueID(const Twine Path, UniqueID &Result);
677 /// This class represents a memory mapped file. It is based on
678 /// boost::iostreams::mapped_file.
679 class mapped_file_region {
680 mapped_file_region() LLVM_DELETED_FUNCTION;
681 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
682 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
686 readonly, ///< May only access map via const_data as read only.
687 readwrite, ///< May access map via data and modify it. Written to path.
688 priv ///< May modify via data, but changes are lost on destruction.
692 /// Platform specific mapping state.
699 void *FileMappingHandle;
702 error_code init(int FD, bool CloseFD, uint64_t Offset);
705 typedef char char_type;
707 #if LLVM_HAS_RVALUE_REFERENCES
708 mapped_file_region(mapped_file_region&&);
709 mapped_file_region &operator =(mapped_file_region&&);
712 /// Construct a mapped_file_region at \a path starting at \a offset of length
713 /// \a length and with access \a mode.
715 /// \param path Path to the file to map. If it does not exist it will be
717 /// \param mode How to map the memory.
718 /// \param length Number of bytes to map in starting at \a offset. If the file
719 /// is shorter than this, it will be extended. If \a length is
720 /// 0, the entire file will be mapped.
721 /// \param offset Byte offset from the beginning of the file where the map
722 /// should begin. Must be a multiple of
723 /// mapped_file_region::alignment().
724 /// \param ec This is set to errc::success if the map was constructed
725 /// successfully. Otherwise it is set to a platform dependent error.
726 mapped_file_region(const Twine &path,
732 /// \param fd An open file descriptor to map. mapped_file_region takes
733 /// ownership if closefd is true. It must have been opended in the correct
735 mapped_file_region(int fd,
742 ~mapped_file_region();
744 mapmode flags() const;
745 uint64_t size() const;
748 /// Get a const view of the data. Modifying this memory has undefined
750 const char *const_data() const;
752 /// \returns The minimum alignment offset must be.
753 static int alignment();
756 /// @brief Memory maps the contents of a file
758 /// @param path Path to file to map.
759 /// @param file_offset Byte offset in file where mapping should begin.
760 /// @param size Byte length of range of the file to map.
761 /// @param map_writable If true, the file will be mapped in r/w such
762 /// that changes to the mapped buffer will be flushed back
763 /// to the file. If false, the file will be mapped read-only
764 /// and the buffer will be read-only.
765 /// @param result Set to the start address of the mapped buffer.
766 /// @returns errc::success if result has been successfully set, otherwise a
767 /// platform specific error_code.
768 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
769 bool map_writable, void *&result);
772 /// @brief Memory unmaps the contents of a file
774 /// @param base Pointer to the start of the buffer.
775 /// @param size Byte length of the range to unmmap.
776 /// @returns errc::success if result has been successfully set, otherwise a
777 /// platform specific error_code.
778 error_code unmap_file_pages(void *base, size_t size);
780 /// Return the path to the main executable, given the value of argv[0] from
781 /// program startup and the address of main itself. In extremis, this function
782 /// may fail and return an empty path.
783 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
789 /// directory_entry - A single entry in a directory. Caches the status either
790 /// from the result of the iteration syscall, or the first time status is
792 class directory_entry {
794 mutable file_status Status;
797 explicit directory_entry(const Twine &path, file_status st = file_status())
803 void assign(const Twine &path, file_status st = file_status()) {
808 void replace_filename(const Twine &filename, file_status st = file_status());
810 const std::string &path() const { return Path; }
811 error_code status(file_status &result) const;
813 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
814 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
815 bool operator< (const directory_entry& rhs) const;
816 bool operator<=(const directory_entry& rhs) const;
817 bool operator> (const directory_entry& rhs) const;
818 bool operator>=(const directory_entry& rhs) const;
824 error_code directory_iterator_construct(DirIterState&, StringRef);
825 error_code directory_iterator_increment(DirIterState&);
826 error_code directory_iterator_destruct(DirIterState&);
828 /// DirIterState - Keeps state for the directory_iterator. It is reference
829 /// counted in order to preserve InputIterator semantics on copy.
830 struct DirIterState : public RefCountedBase<DirIterState> {
832 : IterationHandle(0) {}
835 directory_iterator_destruct(*this);
838 intptr_t IterationHandle;
839 directory_entry CurrentEntry;
843 /// directory_iterator - Iterates through the entries in path. There is no
844 /// operator++ because we need an error_code. If it's really needed we can make
845 /// it call report_fatal_error on error.
846 class directory_iterator {
847 IntrusiveRefCntPtr<detail::DirIterState> State;
850 explicit directory_iterator(const Twine &path, error_code &ec) {
851 State = new detail::DirIterState;
852 SmallString<128> path_storage;
853 ec = detail::directory_iterator_construct(*State,
854 path.toStringRef(path_storage));
857 explicit directory_iterator(const directory_entry &de, error_code &ec) {
858 State = new detail::DirIterState;
859 ec = detail::directory_iterator_construct(*State, de.path());
862 /// Construct end iterator.
863 directory_iterator() : State(0) {}
865 // No operator++ because we need error_code.
866 directory_iterator &increment(error_code &ec) {
867 ec = directory_iterator_increment(*State);
871 const directory_entry &operator*() const { return State->CurrentEntry; }
872 const directory_entry *operator->() const { return &State->CurrentEntry; }
874 bool operator==(const directory_iterator &RHS) const {
875 if (State == RHS.State)
878 return State->CurrentEntry == directory_entry();
880 return RHS.State->CurrentEntry == directory_entry();
881 return State->CurrentEntry == RHS.State->CurrentEntry;
884 bool operator!=(const directory_iterator &RHS) const {
885 return !(*this == RHS);
887 // Other members as required by
888 // C++ Std, 24.1.1 Input iterators [input.iterators]
892 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
893 /// reference counted in order to preserve InputIterator semantics on copy.
894 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
897 , HasNoPushRequest(false) {}
899 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
901 bool HasNoPushRequest;
905 /// recursive_directory_iterator - Same as directory_iterator except for it
906 /// recurses down into child directories.
907 class recursive_directory_iterator {
908 IntrusiveRefCntPtr<detail::RecDirIterState> State;
911 recursive_directory_iterator() {}
912 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
913 : State(new detail::RecDirIterState) {
914 State->Stack.push(directory_iterator(path, ec));
915 if (State->Stack.top() == directory_iterator())
918 // No operator++ because we need error_code.
919 recursive_directory_iterator &increment(error_code &ec) {
920 const directory_iterator end_itr;
922 if (State->HasNoPushRequest)
923 State->HasNoPushRequest = false;
926 if ((ec = State->Stack.top()->status(st))) return *this;
927 if (is_directory(st)) {
928 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
929 if (ec) return *this;
930 if (State->Stack.top() != end_itr) {
938 while (!State->Stack.empty()
939 && State->Stack.top().increment(ec) == end_itr) {
944 // Check if we are done. If so, create an end iterator.
945 if (State->Stack.empty())
951 const directory_entry &operator*() const { return *State->Stack.top(); }
952 const directory_entry *operator->() const { return &*State->Stack.top(); }
955 /// Gets the current level. Starting path is at level 0.
956 int level() const { return State->Level; }
958 /// Returns true if no_push has been called for this directory_entry.
959 bool no_push_request() const { return State->HasNoPushRequest; }
962 /// Goes up one level if Level > 0.
964 assert(State && "Cannot pop an end iterator!");
965 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
967 const directory_iterator end_itr;
971 report_fatal_error("Error incrementing directory iterator.");
974 } while (!State->Stack.empty()
975 && State->Stack.top().increment(ec) == end_itr);
977 // Check if we are done. If so, create an end iterator.
978 if (State->Stack.empty())
982 /// Does not go down into the current directory_entry.
983 void no_push() { State->HasNoPushRequest = true; }
985 bool operator==(const recursive_directory_iterator &RHS) const {
986 return State == RHS.State;
989 bool operator!=(const recursive_directory_iterator &RHS) const {
990 return !(*this == RHS);
992 // Other members as required by
993 // C++ Std, 24.1.1 Input iterators [input.iterators]
998 } // end namespace fs
999 } // end namespace sys
1000 } // end namespace llvm