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/SmallString.h"
32 #include "llvm/ADT/Twine.h"
33 #include "llvm/Support/DataTypes.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/TimeValue.h"
36 #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 std::tie(Device, File) < std::tie(Other.Device, Other.File);
140 uint64_t getDevice() const { return Device; }
141 uint64_t getFile() const { return File; }
144 /// file_status - Represents the result of a call to stat and friends. It has
145 /// a platform specific member to store the result.
148 #if defined(LLVM_ON_UNIX)
155 #elif defined (LLVM_ON_WIN32)
156 uint32_t LastWriteTimeHigh;
157 uint32_t LastWriteTimeLow;
158 uint32_t VolumeSerialNumber;
159 uint32_t FileSizeHigh;
160 uint32_t FileSizeLow;
161 uint32_t FileIndexHigh;
162 uint32_t FileIndexLow;
164 friend bool equivalent(file_status A, file_status B);
168 #if defined(LLVM_ON_UNIX)
169 file_status() : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
170 fs_st_uid(0), fs_st_gid(0), fs_st_size(0),
171 Type(file_type::status_error), Perms(perms_not_known) {}
173 file_status(file_type Type) : fs_st_dev(0), fs_st_ino(0), fs_st_mtime(0),
174 fs_st_uid(0), fs_st_gid(0), fs_st_size(0), Type(Type),
175 Perms(perms_not_known) {}
177 file_status(file_type Type, perms Perms, dev_t Dev, ino_t Ino, time_t MTime,
178 uid_t UID, gid_t GID, off_t Size)
179 : fs_st_dev(Dev), fs_st_ino(Ino), fs_st_mtime(MTime), fs_st_uid(UID),
180 fs_st_gid(GID), fs_st_size(Size), Type(Type), Perms(Perms) {}
181 #elif defined(LLVM_ON_WIN32)
182 file_status() : LastWriteTimeHigh(0), LastWriteTimeLow(0),
183 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
184 FileIndexHigh(0), FileIndexLow(0), Type(file_type::status_error),
185 Perms(perms_not_known) {}
187 file_status(file_type Type) : LastWriteTimeHigh(0), LastWriteTimeLow(0),
188 VolumeSerialNumber(0), FileSizeHigh(0), FileSizeLow(0),
189 FileIndexHigh(0), FileIndexLow(0), Type(Type),
190 Perms(perms_not_known) {}
192 file_status(file_type Type, uint32_t LastWriteTimeHigh,
193 uint32_t LastWriteTimeLow, uint32_t VolumeSerialNumber,
194 uint32_t FileSizeHigh, uint32_t FileSizeLow,
195 uint32_t FileIndexHigh, uint32_t FileIndexLow)
196 : LastWriteTimeHigh(LastWriteTimeHigh),
197 LastWriteTimeLow(LastWriteTimeLow),
198 VolumeSerialNumber(VolumeSerialNumber), FileSizeHigh(FileSizeHigh),
199 FileSizeLow(FileSizeLow), FileIndexHigh(FileIndexHigh),
200 FileIndexLow(FileIndexLow), Type(Type), Perms(perms_not_known) {}
204 file_type type() const { return Type; }
205 perms permissions() const { return Perms; }
206 TimeValue getLastModificationTime() const;
207 UniqueID getUniqueID() const;
209 #if defined(LLVM_ON_UNIX)
210 uint32_t getUser() const { return fs_st_uid; }
211 uint32_t getGroup() const { return fs_st_gid; }
212 uint64_t getSize() const { return fs_st_size; }
213 #elif defined (LLVM_ON_WIN32)
214 uint32_t getUser() const {
215 return 9999; // Not applicable to Windows, so...
217 uint32_t getGroup() const {
218 return 9999; // Not applicable to Windows, so...
220 uint64_t getSize() const {
221 return (uint64_t(FileSizeHigh) << 32) + FileSizeLow;
226 void type(file_type v) { Type = v; }
227 void permissions(perms p) { Perms = p; }
230 /// file_magic - An "enum class" enumeration of file types based on magic (the first
231 /// N bytes of the file).
234 unknown = 0, ///< Unrecognized file
235 bitcode, ///< Bitcode file
236 archive, ///< ar style archive file
237 elf_relocatable, ///< ELF Relocatable object file
238 elf_executable, ///< ELF Executable image
239 elf_shared_object, ///< ELF dynamically linked shared lib
240 elf_core, ///< ELF core image
241 macho_object, ///< Mach-O Object file
242 macho_executable, ///< Mach-O Executable
243 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
244 macho_core, ///< Mach-O Core File
245 macho_preload_executable, ///< Mach-O Preloaded Executable
246 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
247 macho_dynamic_linker, ///< The Mach-O dynamic linker
248 macho_bundle, ///< Mach-O Bundle file
249 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
250 macho_dsym_companion, ///< Mach-O dSYM companion file
251 macho_universal_binary, ///< Mach-O universal binary
252 coff_object, ///< COFF object file
253 coff_import_library, ///< COFF import library
254 pecoff_executable, ///< PECOFF executable file
255 windows_resource ///< Windows compiled resource file (.rc)
258 bool is_object() const {
259 return V == unknown ? false : true;
262 file_magic() : V(unknown) {}
263 file_magic(Impl V) : V(V) {}
264 operator Impl() const { return V; }
271 /// @name Physical Operators
274 /// @brief Make \a path an absolute path.
276 /// Makes \a path absolute using the current directory if it is not already. An
277 /// empty \a path will result in the current directory.
279 /// /absolute/path => /absolute/path
280 /// relative/../path => <current-directory>/relative/../path
282 /// @param path A path that is modified to be an absolute path.
283 /// @returns errc::success if \a path has been made absolute, otherwise a
284 /// platform specific error_code.
285 error_code make_absolute(SmallVectorImpl<char> &path);
287 /// @brief Normalize path separators in \a Path
289 /// If the path contains any '\' separators, they are transformed into '/'.
290 /// This is particularly useful when cross-compiling Windows on Linux, but is
291 /// safe to invoke on Windows, which accepts both characters as a path
293 error_code normalize_separators(SmallVectorImpl<char> &Path);
295 /// @brief Create all the non-existent directories in path.
297 /// @param path Directories to create.
298 /// @returns errc::success if is_directory(path), otherwise a platform
299 /// specific error_code. If IgnoreExisting is false, also returns
300 /// error if the directory already existed.
301 error_code create_directories(const Twine &path, bool IgnoreExisting = true);
303 /// @brief Create the directory in path.
305 /// @param path Directory to create.
306 /// @returns errc::success if is_directory(path), otherwise a platform
307 /// specific error_code. If IgnoreExisting is false, also returns
308 /// error if the directory already existed.
309 error_code create_directory(const Twine &path, bool IgnoreExisting = true);
311 /// @brief Create a link from \a from to \a to.
313 /// The link may be a soft or a hard link, depending on the platform. The caller
314 /// may not assume which one. Currently on windows it creates a hard link since
315 /// soft links require extra privileges. On unix, it creates a soft link since
316 /// hard links don't work on SMB file systems.
318 /// @param to The path to hard link to.
319 /// @param from The path to hard link from. This is created.
320 /// @returns errc::success if the link was created, otherwise a platform
321 /// specific error_code.
322 error_code create_link(const Twine &to, const Twine &from);
324 /// @brief Get the current path.
326 /// @param result Holds the current path on return.
327 /// @returns errc::success if the current path has been stored in result,
328 /// otherwise a platform specific error_code.
329 error_code current_path(SmallVectorImpl<char> &result);
331 /// @brief Remove path. Equivalent to POSIX remove().
333 /// @param path Input path.
334 /// @returns errc::success if path has been removed or didn't exist, otherwise a
335 /// platform specific error code. If IgnoreNonExisting is false, also
336 /// returns error if the file didn't exist.
337 error_code remove(const Twine &path, bool IgnoreNonExisting = true);
339 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
341 /// @param from The path to rename from.
342 /// @param to The path to rename to. This is created.
343 error_code rename(const Twine &from, const Twine &to);
345 /// @brief Resize path to size. File is resized as if by POSIX truncate().
347 /// @param path Input path.
348 /// @param size Size to resize to.
349 /// @returns errc::success if \a path has been resized to \a size, otherwise a
350 /// platform specific error_code.
351 error_code resize_file(const Twine &path, uint64_t size);
354 /// @name Physical Observers
357 /// @brief Does file exist?
359 /// @param status A file_status previously returned from stat.
360 /// @returns True if the file represented by status exists, false if it does
362 bool exists(file_status status);
364 /// @brief Does file exist?
366 /// @param path Input path.
367 /// @param result Set to true if the file represented by status exists, false if
368 /// it does not. Undefined otherwise.
369 /// @returns errc::success if result has been successfully set, otherwise a
370 /// platform specific error_code.
371 error_code exists(const Twine &path, bool &result);
373 /// @brief Simpler version of exists for clients that don't need to
374 /// differentiate between an error and false.
375 inline bool exists(const Twine &path) {
377 return !exists(path, result) && result;
380 /// @brief Can we execute this file?
382 /// @param Path Input path.
383 /// @returns True if we can execute it, false otherwise.
384 bool can_execute(const Twine &Path);
386 /// @brief Can we write this file?
388 /// @param Path Input path.
389 /// @returns True if we can write to it, false otherwise.
390 bool can_write(const Twine &Path);
392 /// @brief Do file_status's represent the same thing?
394 /// @param A Input file_status.
395 /// @param B Input file_status.
397 /// assert(status_known(A) || status_known(B));
399 /// @returns True if A and B both represent the same file system entity, false
401 bool equivalent(file_status A, file_status B);
403 /// @brief Do paths represent the same thing?
405 /// assert(status_known(A) || status_known(B));
407 /// @param A Input path A.
408 /// @param B Input path B.
409 /// @param result Set to true if stat(A) and stat(B) have the same device and
410 /// inode (or equivalent).
411 /// @returns errc::success if result has been successfully set, otherwise a
412 /// platform specific error_code.
413 error_code equivalent(const Twine &A, const Twine &B, bool &result);
415 /// @brief Simpler version of equivalent for clients that don't need to
416 /// differentiate between an error and false.
417 inline bool equivalent(const Twine &A, const Twine &B) {
419 return !equivalent(A, B, result) && result;
422 /// @brief Does status represent a directory?
424 /// @param status A file_status previously returned from status.
425 /// @returns status.type() == file_type::directory_file.
426 bool is_directory(file_status status);
428 /// @brief Is path a directory?
430 /// @param path Input path.
431 /// @param result Set to true if \a path is a directory, false if it is not.
432 /// Undefined otherwise.
433 /// @returns errc::success if result has been successfully set, otherwise a
434 /// platform specific error_code.
435 error_code is_directory(const Twine &path, bool &result);
437 /// @brief Simpler version of is_directory for clients that don't need to
438 /// differentiate between an error and false.
439 inline bool is_directory(const Twine &Path) {
441 return !is_directory(Path, Result) && Result;
444 /// @brief Does status represent a regular file?
446 /// @param status A file_status previously returned from status.
447 /// @returns status_known(status) && status.type() == file_type::regular_file.
448 bool is_regular_file(file_status status);
450 /// @brief Is path a regular file?
452 /// @param path Input path.
453 /// @param result Set to true if \a path is a regular file, false if it is not.
454 /// Undefined otherwise.
455 /// @returns errc::success if result has been successfully set, otherwise a
456 /// platform specific error_code.
457 error_code is_regular_file(const Twine &path, bool &result);
459 /// @brief Simpler version of is_regular_file for clients that don't need to
460 /// differentiate between an error and false.
461 inline bool is_regular_file(const Twine &Path) {
463 if (is_regular_file(Path, Result))
468 /// @brief Does this status represent something that exists but is not a
469 /// directory, regular file, or symlink?
471 /// @param status A file_status previously returned from status.
472 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s)
473 bool is_other(file_status status);
475 /// @brief Is path something that exists but is not a directory,
476 /// regular file, or symlink?
478 /// @param path Input path.
479 /// @param result Set to true if \a path exists, but is not a directory, regular
480 /// file, or a symlink, false if it does not. Undefined otherwise.
481 /// @returns errc::success if result has been successfully set, otherwise a
482 /// platform specific error_code.
483 error_code is_other(const Twine &path, bool &result);
485 /// @brief Get file status as if by POSIX stat().
487 /// @param path Input path.
488 /// @param result Set to the file status.
489 /// @returns errc::success if result has been successfully set, otherwise a
490 /// platform specific error_code.
491 error_code status(const Twine &path, file_status &result);
493 /// @brief A version for when a file descriptor is already available.
494 error_code status(int FD, file_status &Result);
496 /// @brief Get file size.
498 /// @param Path Input path.
499 /// @param Result Set to the size of the file in \a Path.
500 /// @returns errc::success if result has been successfully set, otherwise a
501 /// platform specific error_code.
502 inline error_code file_size(const Twine &Path, uint64_t &Result) {
504 error_code EC = status(Path, Status);
507 Result = Status.getSize();
508 return error_code::success();
511 /// @brief Set the file modification and access time.
513 /// @returns errc::success if the file times were successfully set, otherwise a
514 /// platform specific error_code or errc::not_supported on platforms
515 /// where the functionality isn't available.
516 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
518 /// @brief Is status available?
520 /// @param s Input file status.
521 /// @returns True if status() != status_error.
522 bool status_known(file_status s);
524 /// @brief Is status available?
526 /// @param path Input path.
527 /// @param result Set to true if status() != status_error.
528 /// @returns errc::success if result has been successfully set, otherwise a
529 /// platform specific error_code.
530 error_code status_known(const Twine &path, bool &result);
532 /// @brief Create a uniquely named file.
534 /// Generates a unique path suitable for a temporary file and then opens it as a
535 /// file. The name is based on \a model with '%' replaced by a random char in
536 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
537 /// directory will be prepended.
539 /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s
541 /// This is an atomic operation. Either the file is created and opened, or the
542 /// file system is left untouched.
544 /// The intendend use is for files that are to be kept, possibly after
545 /// renaming them. For example, when running 'clang -c foo.o', the file can
546 /// be first created as foo-abc123.o and then renamed.
548 /// @param Model Name to base unique path off of.
549 /// @param ResultFD Set to the opened file's file descriptor.
550 /// @param ResultPath Set to the opened file's absolute path.
551 /// @returns errc::success if Result{FD,Path} have been successfully set,
552 /// otherwise a platform specific error_code.
553 error_code createUniqueFile(const Twine &Model, int &ResultFD,
554 SmallVectorImpl<char> &ResultPath,
555 unsigned Mode = all_read | all_write);
557 /// @brief Simpler version for clients that don't want an open file.
558 error_code createUniqueFile(const Twine &Model,
559 SmallVectorImpl<char> &ResultPath);
561 /// @brief Create a file in the system temporary directory.
563 /// The filename is of the form prefix-random_chars.suffix. Since the directory
564 /// is not know to the caller, Prefix and Suffix cannot have path separators.
565 /// The files are created with mode 0600.
567 /// This should be used for things like a temporary .s that is removed after
568 /// running the assembler.
569 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
571 SmallVectorImpl<char> &ResultPath);
573 /// @brief Simpler version for clients that don't want an open file.
574 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
575 SmallVectorImpl<char> &ResultPath);
577 error_code createUniqueDirectory(const Twine &Prefix,
578 SmallVectorImpl<char> &ResultPath);
583 /// F_Excl - When opening a file, this flag makes raw_fd_ostream
584 /// report an error if the file already exists.
587 /// F_Append - When opening a file, if it already exists append to the
588 /// existing file instead of returning an error. This may not be specified
592 /// The file should be opened in text mode on platforms that make this
596 /// Open the file for read and write.
600 inline OpenFlags operator|(OpenFlags A, OpenFlags B) {
601 return OpenFlags(unsigned(A) | unsigned(B));
604 inline OpenFlags &operator|=(OpenFlags &A, OpenFlags B) {
609 error_code openFileForWrite(const Twine &Name, int &ResultFD, OpenFlags Flags,
610 unsigned Mode = 0666);
612 error_code openFileForRead(const Twine &Name, int &ResultFD);
614 /// @brief Are \a path's first bytes \a magic?
616 /// @param path Input path.
617 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
618 /// @returns errc::success if result has been successfully set, otherwise a
619 /// platform specific error_code.
620 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
622 /// @brief Get \a path's first \a len bytes.
624 /// @param path Input path.
625 /// @param len Number of magic bytes to get.
626 /// @param result Set to the first \a len bytes in the file pointed to by
627 /// \a path. Or the entire file if file_size(path) < len, in which
628 /// case result.size() returns the size of the file.
629 /// @returns errc::success if result has been successfully set,
630 /// errc::value_too_large if len is larger then the file pointed to by
631 /// \a path, otherwise a platform specific error_code.
632 error_code get_magic(const Twine &path, uint32_t len,
633 SmallVectorImpl<char> &result);
635 /// @brief Identify the type of a binary file based on how magical it is.
636 file_magic identify_magic(StringRef magic);
638 /// @brief Get and identify \a path's type based on its content.
640 /// @param path Input path.
641 /// @param result Set to the type of file, or file_magic::unknown.
642 /// @returns errc::success if result has been successfully set, otherwise a
643 /// platform specific error_code.
644 error_code identify_magic(const Twine &path, file_magic &result);
646 error_code getUniqueID(const Twine Path, UniqueID &Result);
648 /// This class represents a memory mapped file. It is based on
649 /// boost::iostreams::mapped_file.
650 class mapped_file_region {
651 mapped_file_region() LLVM_DELETED_FUNCTION;
652 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
653 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
657 readonly, ///< May only access map via const_data as read only.
658 readwrite, ///< May access map via data and modify it. Written to path.
659 priv ///< May modify via data, but changes are lost on destruction.
663 /// Platform specific mapping state.
670 void *FileMappingHandle;
673 error_code init(int FD, bool CloseFD, uint64_t Offset);
676 typedef char char_type;
678 mapped_file_region(mapped_file_region&&);
679 mapped_file_region &operator =(mapped_file_region&&);
681 /// Construct a mapped_file_region at \a path starting at \a offset of length
682 /// \a length and with access \a mode.
684 /// \param path Path to the file to map. If it does not exist it will be
686 /// \param mode How to map the memory.
687 /// \param length Number of bytes to map in starting at \a offset. If the file
688 /// is shorter than this, it will be extended. If \a length is
689 /// 0, the entire file will be mapped.
690 /// \param offset Byte offset from the beginning of the file where the map
691 /// should begin. Must be a multiple of
692 /// mapped_file_region::alignment().
693 /// \param ec This is set to errc::success if the map was constructed
694 /// successfully. Otherwise it is set to a platform dependent error.
695 mapped_file_region(const Twine &path,
701 /// \param fd An open file descriptor to map. mapped_file_region takes
702 /// ownership if closefd is true. It must have been opended in the correct
704 mapped_file_region(int fd,
711 ~mapped_file_region();
713 mapmode flags() const;
714 uint64_t size() const;
717 /// Get a const view of the data. Modifying this memory has undefined
719 const char *const_data() const;
721 /// \returns The minimum alignment offset must be.
722 static int alignment();
725 /// @brief Memory maps the contents of a file
727 /// @param path Path to file to map.
728 /// @param file_offset Byte offset in file where mapping should begin.
729 /// @param size Byte length of range of the file to map.
730 /// @param map_writable If true, the file will be mapped in r/w such
731 /// that changes to the mapped buffer will be flushed back
732 /// to the file. If false, the file will be mapped read-only
733 /// and the buffer will be read-only.
734 /// @param result Set to the start address of the mapped buffer.
735 /// @returns errc::success if result has been successfully set, otherwise a
736 /// platform specific error_code.
737 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
738 bool map_writable, void *&result);
741 /// @brief Memory unmaps the contents of a file
743 /// @param base Pointer to the start of the buffer.
744 /// @param size Byte length of the range to unmmap.
745 /// @returns errc::success if result has been successfully set, otherwise a
746 /// platform specific error_code.
747 error_code unmap_file_pages(void *base, size_t size);
749 /// Return the path to the main executable, given the value of argv[0] from
750 /// program startup and the address of main itself. In extremis, this function
751 /// may fail and return an empty path.
752 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
758 /// directory_entry - A single entry in a directory. Caches the status either
759 /// from the result of the iteration syscall, or the first time status is
761 class directory_entry {
763 mutable file_status Status;
766 explicit directory_entry(const Twine &path, file_status st = file_status())
772 void assign(const Twine &path, file_status st = file_status()) {
777 void replace_filename(const Twine &filename, file_status st = file_status());
779 const std::string &path() const { return Path; }
780 error_code status(file_status &result) const;
782 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
783 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
784 bool operator< (const directory_entry& rhs) const;
785 bool operator<=(const directory_entry& rhs) const;
786 bool operator> (const directory_entry& rhs) const;
787 bool operator>=(const directory_entry& rhs) const;
793 error_code directory_iterator_construct(DirIterState&, StringRef);
794 error_code directory_iterator_increment(DirIterState&);
795 error_code directory_iterator_destruct(DirIterState&);
797 /// DirIterState - Keeps state for the directory_iterator. It is reference
798 /// counted in order to preserve InputIterator semantics on copy.
799 struct DirIterState : public RefCountedBase<DirIterState> {
801 : IterationHandle(0) {}
804 directory_iterator_destruct(*this);
807 intptr_t IterationHandle;
808 directory_entry CurrentEntry;
812 /// directory_iterator - Iterates through the entries in path. There is no
813 /// operator++ because we need an error_code. If it's really needed we can make
814 /// it call report_fatal_error on error.
815 class directory_iterator {
816 IntrusiveRefCntPtr<detail::DirIterState> State;
819 explicit directory_iterator(const Twine &path, error_code &ec) {
820 State = new detail::DirIterState;
821 SmallString<128> path_storage;
822 ec = detail::directory_iterator_construct(*State,
823 path.toStringRef(path_storage));
826 explicit directory_iterator(const directory_entry &de, error_code &ec) {
827 State = new detail::DirIterState;
828 ec = detail::directory_iterator_construct(*State, de.path());
831 /// Construct end iterator.
832 directory_iterator() : State(nullptr) {}
834 // No operator++ because we need error_code.
835 directory_iterator &increment(error_code &ec) {
836 ec = directory_iterator_increment(*State);
840 const directory_entry &operator*() const { return State->CurrentEntry; }
841 const directory_entry *operator->() const { return &State->CurrentEntry; }
843 bool operator==(const directory_iterator &RHS) const {
844 if (State == RHS.State)
847 return State->CurrentEntry == directory_entry();
849 return RHS.State->CurrentEntry == directory_entry();
850 return State->CurrentEntry == RHS.State->CurrentEntry;
853 bool operator!=(const directory_iterator &RHS) const {
854 return !(*this == RHS);
856 // Other members as required by
857 // C++ Std, 24.1.1 Input iterators [input.iterators]
861 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
862 /// reference counted in order to preserve InputIterator semantics on copy.
863 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
866 , HasNoPushRequest(false) {}
868 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
870 bool HasNoPushRequest;
874 /// recursive_directory_iterator - Same as directory_iterator except for it
875 /// recurses down into child directories.
876 class recursive_directory_iterator {
877 IntrusiveRefCntPtr<detail::RecDirIterState> State;
880 recursive_directory_iterator() {}
881 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
882 : State(new detail::RecDirIterState) {
883 State->Stack.push(directory_iterator(path, ec));
884 if (State->Stack.top() == directory_iterator())
887 // No operator++ because we need error_code.
888 recursive_directory_iterator &increment(error_code &ec) {
889 const directory_iterator end_itr;
891 if (State->HasNoPushRequest)
892 State->HasNoPushRequest = false;
895 if ((ec = State->Stack.top()->status(st))) return *this;
896 if (is_directory(st)) {
897 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
898 if (ec) return *this;
899 if (State->Stack.top() != end_itr) {
907 while (!State->Stack.empty()
908 && State->Stack.top().increment(ec) == end_itr) {
913 // Check if we are done. If so, create an end iterator.
914 if (State->Stack.empty())
920 const directory_entry &operator*() const { return *State->Stack.top(); }
921 const directory_entry *operator->() const { return &*State->Stack.top(); }
924 /// Gets the current level. Starting path is at level 0.
925 int level() const { return State->Level; }
927 /// Returns true if no_push has been called for this directory_entry.
928 bool no_push_request() const { return State->HasNoPushRequest; }
931 /// Goes up one level if Level > 0.
933 assert(State && "Cannot pop an end iterator!");
934 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
936 const directory_iterator end_itr;
940 report_fatal_error("Error incrementing directory iterator.");
943 } while (!State->Stack.empty()
944 && State->Stack.top().increment(ec) == end_itr);
946 // Check if we are done. If so, create an end iterator.
947 if (State->Stack.empty())
951 /// Does not go down into the current directory_entry.
952 void no_push() { State->HasNoPushRequest = true; }
954 bool operator==(const recursive_directory_iterator &RHS) const {
955 return State == RHS.State;
958 bool operator!=(const recursive_directory_iterator &RHS) const {
959 return !(*this == RHS);
961 // Other members as required by
962 // C++ Std, 24.1.1 Input iterators [input.iterators]
967 } // end namespace fs
968 } // end namespace sys
969 } // end namespace llvm