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 Rename \a from to \a to. Files are renamed as if by POSIX rename().
346 /// @param from The path to rename from.
347 /// @param to The path to rename to. This is created.
348 error_code rename(const Twine &from, const Twine &to);
350 /// @brief Resize path to size. File is resized as if by POSIX truncate().
352 /// @param path Input path.
353 /// @param size Size to resize to.
354 /// @returns errc::success if \a path has been resized to \a size, otherwise a
355 /// platform specific error_code.
356 error_code resize_file(const Twine &path, uint64_t size);
359 /// @name Physical Observers
362 /// @brief Does file exist?
364 /// @param status A file_status previously returned from stat.
365 /// @returns True if the file represented by status exists, false if it does
367 bool exists(file_status status);
369 /// @brief Does file exist?
371 /// @param path Input path.
372 /// @param result Set to true if the file represented by status exists, false if
373 /// it does not. Undefined otherwise.
374 /// @returns errc::success if result has been successfully set, otherwise a
375 /// platform specific error_code.
376 error_code exists(const Twine &path, bool &result);
378 /// @brief Simpler version of exists for clients that don't need to
379 /// differentiate between an error and false.
380 inline bool exists(const Twine &path) {
382 return !exists(path, result) && result;
385 /// @brief Can we execute this file?
387 /// @param Path Input path.
388 /// @returns True if we can execute it, false otherwise.
389 bool can_execute(const Twine &Path);
391 /// @brief Can we write this file?
393 /// @param Path Input path.
394 /// @returns True if we can write to it, false otherwise.
395 bool can_write(const Twine &Path);
397 /// @brief Do file_status's represent the same thing?
399 /// @param A Input file_status.
400 /// @param B Input file_status.
402 /// assert(status_known(A) || status_known(B));
404 /// @returns True if A and B both represent the same file system entity, false
406 bool equivalent(file_status A, file_status B);
408 /// @brief Do paths represent the same thing?
410 /// assert(status_known(A) || status_known(B));
412 /// @param A Input path A.
413 /// @param B Input path B.
414 /// @param result Set to true if stat(A) and stat(B) have the same device and
415 /// inode (or equivalent).
416 /// @returns errc::success if result has been successfully set, otherwise a
417 /// platform specific error_code.
418 error_code equivalent(const Twine &A, const Twine &B, bool &result);
420 /// @brief Simpler version of equivalent for clients that don't need to
421 /// differentiate between an error and false.
422 inline bool equivalent(const Twine &A, const Twine &B) {
424 return !equivalent(A, B, result) && result;
427 /// @brief Does status represent a directory?
429 /// @param status A file_status previously returned from status.
430 /// @returns status.type() == file_type::directory_file.
431 bool is_directory(file_status status);
433 /// @brief Is path a directory?
435 /// @param path Input path.
436 /// @param result Set to true if \a path is a directory, false if it is not.
437 /// Undefined otherwise.
438 /// @returns errc::success if result has been successfully set, otherwise a
439 /// platform specific error_code.
440 error_code is_directory(const Twine &path, bool &result);
442 /// @brief Simpler version of is_directory for clients that don't need to
443 /// differentiate between an error and false.
444 inline bool is_directory(const Twine &Path) {
446 return !is_directory(Path, Result) && Result;
449 /// @brief Does status represent a regular file?
451 /// @param status A file_status previously returned from status.
452 /// @returns status_known(status) && status.type() == file_type::regular_file.
453 bool is_regular_file(file_status status);
455 /// @brief Is path a regular file?
457 /// @param path Input path.
458 /// @param result Set to true if \a path is a regular file, false if it is not.
459 /// Undefined otherwise.
460 /// @returns errc::success if result has been successfully set, otherwise a
461 /// platform specific error_code.
462 error_code is_regular_file(const Twine &path, bool &result);
464 /// @brief Simpler version of is_regular_file for clients that don't need to
465 /// differentiate between an error and false.
466 inline bool is_regular_file(const Twine &Path) {
468 if (is_regular_file(Path, Result))
473 /// @brief Does this status represent something that exists but is not a
474 /// directory, regular file, or symlink?
476 /// @param status A file_status previously returned from status.
477 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
479 bool is_other(file_status status);
481 /// @brief Is path something that exists but is not a directory,
482 /// regular file, or symlink?
484 /// @param path Input path.
485 /// @param result Set to true if \a path exists, but is not a directory, regular
486 /// file, or a symlink, false if it does not. Undefined otherwise.
487 /// @returns errc::success if result has been successfully set, otherwise a
488 /// platform specific error_code.
489 error_code is_other(const Twine &path, bool &result);
491 /// @brief Does status represent a symlink?
493 /// @param status A file_status previously returned from stat.
494 /// @returns status.type() == symlink_file.
495 bool is_symlink(file_status status);
497 /// @brief Is path a symlink?
499 /// @param path Input path.
500 /// @param result Set to true if \a path is a symlink, false if it is not.
501 /// Undefined otherwise.
502 /// @returns errc::success if result has been successfully set, otherwise a
503 /// platform specific error_code.
504 error_code is_symlink(const Twine &path, bool &result);
506 /// @brief Get file status as if by POSIX stat().
508 /// @param path Input path.
509 /// @param result Set to the file status.
510 /// @returns errc::success if result has been successfully set, otherwise a
511 /// platform specific error_code.
512 error_code status(const Twine &path, file_status &result);
514 /// @brief A version for when a file descriptor is already available.
515 error_code status(int FD, file_status &Result);
517 /// @brief Get file size.
519 /// @param Path Input path.
520 /// @param Result Set to the size of the file in \a Path.
521 /// @returns errc::success if result has been successfully set, otherwise a
522 /// platform specific error_code.
523 inline error_code file_size(const Twine &Path, uint64_t &Result) {
525 error_code EC = status(Path, Status);
528 Result = Status.getSize();
529 return error_code::success();
532 /// @brief Set the file modification and access time.
534 /// @returns errc::success if the file times were successfully set, otherwise a
535 /// platform specific error_code or errc::not_supported on platforms
536 /// where the functionality isn't available.
537 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
539 /// @brief Is status available?
541 /// @param s Input file status.
542 /// @returns True if status() != status_error.
543 bool status_known(file_status s);
545 /// @brief Is status available?
547 /// @param path Input path.
548 /// @param result Set to true if status() != status_error.
549 /// @returns errc::success if result has been successfully set, otherwise a
550 /// platform specific error_code.
551 error_code status_known(const Twine &path, bool &result);
553 /// @brief Create a uniquely named file.
555 /// Generates a unique path suitable for a temporary file and then opens it as a
556 /// file. The name is based on \a model with '%' replaced by a random char in
557 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
558 /// directory will be prepended.
560 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
562 /// This is an atomic operation. Either the file is created and opened, or the
563 /// file system is left untouched.
565 /// The intendend use is for files that are to be kept, possibly after
566 /// renaming them. For example, when running 'clang -c foo.o', the file can
567 /// be first created as foo-abc123.o and then renamed.
569 /// @param Model Name to base unique path off of.
570 /// @param ResultFD Set to the opened file's file descriptor.
571 /// @param ResultPath Set to the opened file's absolute path.
572 /// @returns errc::success if Result{FD,Path} have been successfully set,
573 /// otherwise a platform specific error_code.
574 error_code createUniqueFile(const Twine &Model, int &ResultFD,
575 SmallVectorImpl<char> &ResultPath,
576 unsigned Mode = all_read | all_write);
578 /// @brief Simpler version for clients that don't want an open file.
579 error_code createUniqueFile(const Twine &Model,
580 SmallVectorImpl<char> &ResultPath);
582 /// @brief Create a file in the system temporary directory.
584 /// The filename is of the form prefix-random_chars.suffix. Since the directory
585 /// is not know to the caller, Prefix and Suffix cannot have path separators.
586 /// The files are created with mode 0600.
588 /// This should be used for things like a temporary .s that is removed after
589 /// running the assembler.
590 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
592 SmallVectorImpl<char> &ResultPath);
594 /// @brief Simpler version for clients that don't want an open file.
595 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
596 SmallVectorImpl<char> &ResultPath);
598 error_code createUniqueDirectory(const Twine &Prefix,
599 SmallVectorImpl<char> &ResultPath);
604 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
605 /// report an error if the file already exists.
608 /// F_Append - When opening a file, if it already exists append to the
609 /// existing file instead of returning an error. This may not be specified
613 /// F_Binary - The file should be opened in binary mode on platforms that
614 /// make this distinction.
618 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
619 return OpenFlags(unsigned(A) | unsigned(B));
622 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
627 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
628 unsigned Mode = 0666);
630 error_code openFileForRead(const Twine &Name, int &ResultFD);
632 /// @brief Are \a path's first bytes \a magic?
634 /// @param path Input path.
635 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
636 /// @returns errc::success if result has been successfully set, otherwise a
637 /// platform specific error_code.
638 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
640 /// @brief Get \a path's first \a len bytes.
642 /// @param path Input path.
643 /// @param len Number of magic bytes to get.
644 /// @param result Set to the first \a len bytes in the file pointed to by
645 /// \a path. Or the entire file if file_size(path) < len, in which
646 /// case result.size() returns the size of the file.
647 /// @returns errc::success if result has been successfully set,
648 /// errc::value_too_large if len is larger then the file pointed to by
649 /// \a path, otherwise a platform specific error_code.
650 error_code get_magic(const Twine &path, uint32_t len,
651 SmallVectorImpl<char> &result);
653 /// @brief Identify the type of a binary file based on how magical it is.
654 file_magic identify_magic(StringRef magic);
656 /// @brief Get and identify \a path's type based on its content.
658 /// @param path Input path.
659 /// @param result Set to the type of file, or file_magic::unknown.
660 /// @returns errc::success if result has been successfully set, otherwise a
661 /// platform specific error_code.
662 error_code identify_magic(const Twine &path, file_magic &result);
664 error_code getUniqueID(const Twine Path, UniqueID &Result);
666 /// This class represents a memory mapped file. It is based on
667 /// boost::iostreams::mapped_file.
668 class mapped_file_region {
669 mapped_file_region() LLVM_DELETED_FUNCTION;
670 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
671 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
675 readonly, ///< May only access map via const_data as read only.
676 readwrite, ///< May access map via data and modify it. Written to path.
677 priv ///< May modify via data, but changes are lost on destruction.
681 /// Platform specific mapping state.
688 void *FileMappingHandle;
691 error_code init(int FD, bool CloseFD, uint64_t Offset);
694 typedef char char_type;
696 #if LLVM_HAS_RVALUE_REFERENCES
697 mapped_file_region(mapped_file_region&&);
698 mapped_file_region &operator =(mapped_file_region&&);
701 /// Construct a mapped_file_region at \a path starting at \a offset of length
702 /// \a length and with access \a mode.
704 /// \param path Path to the file to map. If it does not exist it will be
706 /// \param mode How to map the memory.
707 /// \param length Number of bytes to map in starting at \a offset. If the file
708 /// is shorter than this, it will be extended. If \a length is
709 /// 0, the entire file will be mapped.
710 /// \param offset Byte offset from the beginning of the file where the map
711 /// should begin. Must be a multiple of
712 /// mapped_file_region::alignment().
713 /// \param ec This is set to errc::success if the map was constructed
714 /// successfully. Otherwise it is set to a platform dependent error.
715 mapped_file_region(const Twine &path,
721 /// \param fd An open file descriptor to map. mapped_file_region takes
722 /// ownership if closefd is true. It must have been opended in the correct
724 mapped_file_region(int fd,
731 ~mapped_file_region();
733 mapmode flags() const;
734 uint64_t size() const;
737 /// Get a const view of the data. Modifying this memory has undefined
739 const char *const_data() const;
741 /// \returns The minimum alignment offset must be.
742 static int alignment();
745 /// @brief Memory maps the contents of a file
747 /// @param path Path to file to map.
748 /// @param file_offset Byte offset in file where mapping should begin.
749 /// @param size Byte length of range of the file to map.
750 /// @param map_writable If true, the file will be mapped in r/w such
751 /// that changes to the mapped buffer will be flushed back
752 /// to the file. If false, the file will be mapped read-only
753 /// and the buffer will be read-only.
754 /// @param result Set to the start address of the mapped buffer.
755 /// @returns errc::success if result has been successfully set, otherwise a
756 /// platform specific error_code.
757 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
758 bool map_writable, void *&result);
761 /// @brief Memory unmaps the contents of a file
763 /// @param base Pointer to the start of the buffer.
764 /// @param size Byte length of the range to unmmap.
765 /// @returns errc::success if result has been successfully set, otherwise a
766 /// platform specific error_code.
767 error_code unmap_file_pages(void *base, size_t size);
769 /// Return the path to the main executable, given the value of argv[0] from
770 /// program startup and the address of main itself. In extremis, this function
771 /// may fail and return an empty path.
772 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
778 /// directory_entry - A single entry in a directory. Caches the status either
779 /// from the result of the iteration syscall, or the first time status is
781 class directory_entry {
783 mutable file_status Status;
786 explicit directory_entry(const Twine &path, file_status st = file_status())
792 void assign(const Twine &path, file_status st = file_status()) {
797 void replace_filename(const Twine &filename, file_status st = file_status());
799 const std::string &path() const { return Path; }
800 error_code status(file_status &result) const;
802 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
803 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
804 bool operator< (const directory_entry& rhs) const;
805 bool operator<=(const directory_entry& rhs) const;
806 bool operator> (const directory_entry& rhs) const;
807 bool operator>=(const directory_entry& rhs) const;
813 error_code directory_iterator_construct(DirIterState&, StringRef);
814 error_code directory_iterator_increment(DirIterState&);
815 error_code directory_iterator_destruct(DirIterState&);
817 /// DirIterState - Keeps state for the directory_iterator. It is reference
818 /// counted in order to preserve InputIterator semantics on copy.
819 struct DirIterState : public RefCountedBase<DirIterState> {
821 : IterationHandle(0) {}
824 directory_iterator_destruct(*this);
827 intptr_t IterationHandle;
828 directory_entry CurrentEntry;
832 /// directory_iterator - Iterates through the entries in path. There is no
833 /// operator++ because we need an error_code. If it's really needed we can make
834 /// it call report_fatal_error on error.
835 class directory_iterator {
836 IntrusiveRefCntPtr<detail::DirIterState> State;
839 explicit directory_iterator(const Twine &path, error_code &ec) {
840 State = new detail::DirIterState;
841 SmallString<128> path_storage;
842 ec = detail::directory_iterator_construct(*State,
843 path.toStringRef(path_storage));
846 explicit directory_iterator(const directory_entry &de, error_code &ec) {
847 State = new detail::DirIterState;
848 ec = detail::directory_iterator_construct(*State, de.path());
851 /// Construct end iterator.
852 directory_iterator() : State(0) {}
854 // No operator++ because we need error_code.
855 directory_iterator &increment(error_code &ec) {
856 ec = directory_iterator_increment(*State);
860 const directory_entry &operator*() const { return State->CurrentEntry; }
861 const directory_entry *operator->() const { return &State->CurrentEntry; }
863 bool operator==(const directory_iterator &RHS) const {
864 if (State == RHS.State)
867 return State->CurrentEntry == directory_entry();
869 return RHS.State->CurrentEntry == directory_entry();
870 return State->CurrentEntry == RHS.State->CurrentEntry;
873 bool operator!=(const directory_iterator &RHS) const {
874 return !(*this == RHS);
876 // Other members as required by
877 // C++ Std, 24.1.1 Input iterators [input.iterators]
881 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
882 /// reference counted in order to preserve InputIterator semantics on copy.
883 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
886 , HasNoPushRequest(false) {}
888 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
890 bool HasNoPushRequest;
894 /// recursive_directory_iterator - Same as directory_iterator except for it
895 /// recurses down into child directories.
896 class recursive_directory_iterator {
897 IntrusiveRefCntPtr<detail::RecDirIterState> State;
900 recursive_directory_iterator() {}
901 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
902 : State(new detail::RecDirIterState) {
903 State->Stack.push(directory_iterator(path, ec));
904 if (State->Stack.top() == directory_iterator())
907 // No operator++ because we need error_code.
908 recursive_directory_iterator &increment(error_code &ec) {
909 const directory_iterator end_itr;
911 if (State->HasNoPushRequest)
912 State->HasNoPushRequest = false;
915 if ((ec = State->Stack.top()->status(st))) return *this;
916 if (is_directory(st)) {
917 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
918 if (ec) return *this;
919 if (State->Stack.top() != end_itr) {
927 while (!State->Stack.empty()
928 && State->Stack.top().increment(ec) == end_itr) {
933 // Check if we are done. If so, create an end iterator.
934 if (State->Stack.empty())
940 const directory_entry &operator*() const { return *State->Stack.top(); }
941 const directory_entry *operator->() const { return &*State->Stack.top(); }
944 /// Gets the current level. Starting path is at level 0.
945 int level() const { return State->Level; }
947 /// Returns true if no_push has been called for this directory_entry.
948 bool no_push_request() const { return State->HasNoPushRequest; }
951 /// Goes up one level if Level > 0.
953 assert(State && "Cannot pop an end iterator!");
954 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
956 const directory_iterator end_itr;
960 report_fatal_error("Error incrementing directory iterator.");
963 } while (!State->Stack.empty()
964 && State->Stack.top().increment(ec) == end_itr);
966 // Check if we are done. If so, create an end iterator.
967 if (State->Stack.empty())
971 /// Does not go down into the current directory_entry.
972 void no_push() { State->HasNoPushRequest = true; }
974 bool operator==(const recursive_directory_iterator &RHS) const {
975 return State == RHS.State;
978 bool operator!=(const recursive_directory_iterator &RHS) const {
979 return !(*this == RHS);
981 // Other members as required by
982 // C++ Std, 24.1.1 Input iterators [input.iterators]
987 } // end namespace fs
988 } // end namespace sys
989 } // end namespace llvm