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 /// copy_option - An "enum class" enumeration of copy semantics for copy
84 copy_option(_ v) : v_(v) {}
85 explicit copy_option(int v) : v_(_(v)) {}
86 operator int() const {return v_;}
92 /// space_info - Self explanatory.
105 owner_all = owner_read | owner_write | owner_exe,
109 group_all = group_read | group_write | group_exe,
113 others_all = others_read | others_write | others_exe,
114 all_read = owner_read | group_read | others_read,
115 all_write = owner_write | group_write | others_write,
116 all_exe = owner_exe | group_exe | others_exe,
117 all_all = owner_all | group_all | others_all,
118 set_uid_on_exe = 04000,
119 set_gid_on_exe = 02000,
121 perms_mask = all_all | set_uid_on_exe | set_gid_on_exe | sticky_bit,
122 perms_not_known = 0xFFFF,
124 remove_perms = 0x2000,
125 symlink_perms = 0x4000
128 // Helper functions so that you can use & and | to manipulate perms bits:
129 inline perms operator|(perms l , perms r) {
130 return static_cast<perms>(
131 static_cast<unsigned short>(l) | static_cast<unsigned short>(r));
133 inline perms operator&(perms l , perms r) {
134 return static_cast<perms>(
135 static_cast<unsigned short>(l) & static_cast<unsigned short>(r));
137 inline perms &operator|=(perms &l, perms r) {
141 inline perms &operator&=(perms &l, perms r) {
145 inline perms operator~(perms x) {
146 return static_cast<perms>(~static_cast<unsigned short>(x));
151 /// file_status - Represents the result of a call to stat and friends. It has
152 /// a platform specific member to store the result.
155 #if defined(LLVM_ON_UNIX)
161 #elif defined (LLVM_ON_WIN32)
162 uint32_t LastWriteTimeHigh;
163 uint32_t LastWriteTimeLow;
164 uint32_t VolumeSerialNumber;
165 uint32_t FileSizeHigh;
166 uint32_t FileSizeLow;
167 uint32_t FileIndexHigh;
168 uint32_t FileIndexLow;
170 friend bool equivalent(file_status A, file_status B);
171 friend error_code status(const Twine &path, file_status &result);
172 friend error_code getUniqueID(const Twine Path, uint64_t &Result);
176 explicit file_status(file_type v=file_type::status_error,
177 perms prms=perms_not_known)
178 : Type(v), Perms(prms) {}
181 file_type type() const { return Type; }
182 perms permissions() const { return Perms; }
183 TimeValue getLastModificationTime() const;
185 #if defined(LLVM_ON_UNIX)
186 uint32_t getUser() const { return fs_st_uid; }
187 uint32_t getGroup() const { return fs_st_gid; }
188 #elif defined (LLVM_ON_WIN32)
189 uint32_t getUser() const {
190 return 9999; // Not applicable to Windows, so...
192 uint32_t getGroup() const {
193 return 9999; // Not applicable to Windows, so...
198 void type(file_type v) { Type = v; }
199 void permissions(perms p) { Perms = p; }
202 /// file_magic - An "enum class" enumeration of file types based on magic (the first
203 /// N bytes of the file).
206 unknown = 0, ///< Unrecognized file
207 bitcode, ///< Bitcode file
208 archive, ///< ar style archive file
209 elf_relocatable, ///< ELF Relocatable object file
210 elf_executable, ///< ELF Executable image
211 elf_shared_object, ///< ELF dynamically linked shared lib
212 elf_core, ///< ELF core image
213 macho_object, ///< Mach-O Object file
214 macho_executable, ///< Mach-O Executable
215 macho_fixed_virtual_memory_shared_lib, ///< Mach-O Shared Lib, FVM
216 macho_core, ///< Mach-O Core File
217 macho_preload_executable, ///< Mach-O Preloaded Executable
218 macho_dynamically_linked_shared_lib, ///< Mach-O dynlinked shared lib
219 macho_dynamic_linker, ///< The Mach-O dynamic linker
220 macho_bundle, ///< Mach-O Bundle file
221 macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
222 macho_dsym_companion, ///< Mach-O dSYM companion file
223 macho_universal_binary, ///< Mach-O universal binary
224 coff_object, ///< COFF object file
225 pecoff_executable ///< PECOFF executable file
228 bool is_object() const {
229 return V == unknown ? false : true;
232 file_magic() : V(unknown) {}
233 file_magic(Impl V) : V(V) {}
234 operator Impl() const { return V; }
241 /// @name Physical Operators
244 /// @brief Make \a path an absolute path.
246 /// Makes \a path absolute using the current directory if it is not already. An
247 /// empty \a path will result in the current directory.
249 /// /absolute/path => /absolute/path
250 /// relative/../path => <current-directory>/relative/../path
252 /// @param path A path that is modified to be an absolute path.
253 /// @returns errc::success if \a path has been made absolute, otherwise a
254 /// platform specific error_code.
255 error_code make_absolute(SmallVectorImpl<char> &path);
257 /// @brief Copy the file at \a from to the path \a to.
259 /// @param from The path to copy the file from.
260 /// @param to The path to copy the file to.
261 /// @param copt Behavior if \a to already exists.
262 /// @returns errc::success if the file has been successfully copied.
263 /// errc::file_exists if \a to already exists and \a copt ==
264 /// copy_option::fail_if_exists. Otherwise a platform specific
266 error_code copy_file(const Twine &from, const Twine &to,
267 copy_option copt = copy_option::fail_if_exists);
269 /// @brief Create all the non-existent directories in path.
271 /// @param path Directories to create.
272 /// @param existed Set to true if \a path already existed, false otherwise.
273 /// @returns errc::success if is_directory(path) and existed have been set,
274 /// otherwise a platform specific error_code.
275 error_code create_directories(const Twine &path, bool &existed);
277 /// @brief Convenience function for clients that don't need to know if the
278 /// directory existed or not.
279 inline error_code create_directories(const Twine &Path) {
281 return create_directories(Path, Existed);
284 /// @brief Create the directory in path.
286 /// @param path Directory to create.
287 /// @param existed Set to true if \a path already existed, false otherwise.
288 /// @returns errc::success if is_directory(path) and existed have been set,
289 /// otherwise a platform specific error_code.
290 error_code create_directory(const Twine &path, bool &existed);
292 /// @brief Convenience function for clients that don't need to know if the
293 /// directory existed or not.
294 inline error_code create_directory(const Twine &Path) {
296 return create_directory(Path, Existed);
299 /// @brief Create a hard link from \a from to \a to.
301 /// @param to The path to hard link to.
302 /// @param from The path to hard link from. This is created.
303 /// @returns errc::success if exists(to) && exists(from) && equivalent(to, from)
304 /// , otherwise a platform specific error_code.
305 error_code create_hard_link(const Twine &to, const Twine &from);
307 /// @brief Create a symbolic link from \a from to \a to.
309 /// @param to The path to symbolically link to.
310 /// @param from The path to symbolically link from. This is created.
311 /// @returns errc::success if exists(to) && exists(from) && is_symlink(from),
312 /// otherwise a platform specific error_code.
313 error_code create_symlink(const Twine &to, const Twine &from);
315 /// @brief Get the current path.
317 /// @param result Holds the current path on return.
318 /// @returns errc::success if the current path has been stored in result,
319 /// otherwise a platform specific error_code.
320 error_code current_path(SmallVectorImpl<char> &result);
322 /// @brief Remove path. Equivalent to POSIX remove().
324 /// @param path Input path.
325 /// @param existed Set to true if \a path existed, false if it did not.
326 /// undefined otherwise.
327 /// @returns errc::success if path has been removed and existed has been
328 /// successfully set, otherwise a platform specific error_code.
329 error_code remove(const Twine &path, bool &existed);
331 /// @brief Convenience function for clients that don't need to know if the file
333 inline error_code remove(const Twine &Path) {
335 return remove(Path, Existed);
338 /// @brief Recursively remove all files below \a path, then \a path. Files are
339 /// removed as if by POSIX remove().
341 /// @param path Input path.
342 /// @param num_removed Number of files removed.
343 /// @returns errc::success if path has been removed and num_removed has been
344 /// successfully set, otherwise a platform specific error_code.
345 error_code remove_all(const Twine &path, uint32_t &num_removed);
347 /// @brief Convenience function for clients that don't need to know how many
348 /// files were removed.
349 inline error_code remove_all(const Twine &Path) {
351 return remove_all(Path, Removed);
354 /// @brief Rename \a from to \a to. Files are renamed as if by POSIX rename().
356 /// @param from The path to rename from.
357 /// @param to The path to rename to. This is created.
358 error_code rename(const Twine &from, const Twine &to);
360 /// @brief Resize path to size. File is resized as if by POSIX truncate().
362 /// @param path Input path.
363 /// @param size Size to resize to.
364 /// @returns errc::success if \a path has been resized to \a size, otherwise a
365 /// platform specific error_code.
366 error_code resize_file(const Twine &path, uint64_t size);
369 /// @name Physical Observers
372 /// @brief Does file exist?
374 /// @param status A file_status previously returned from stat.
375 /// @returns True if the file represented by status exists, false if it does
377 bool exists(file_status status);
379 /// @brief Does file exist?
381 /// @param path Input path.
382 /// @param result Set to true if the file represented by status exists, false if
383 /// it does not. Undefined otherwise.
384 /// @returns errc::success if result has been successfully set, otherwise a
385 /// platform specific error_code.
386 error_code exists(const Twine &path, bool &result);
388 /// @brief Simpler version of exists for clients that don't need to
389 /// differentiate between an error and false.
390 inline bool exists(const Twine &path) {
392 return !exists(path, result) && result;
395 /// @brief Can we execute this file?
397 /// @param Path Input path.
398 /// @returns True if we can execute it, false otherwise.
399 bool can_execute(const Twine &Path);
401 /// @brief Can we write this file?
403 /// @param Path Input path.
404 /// @returns True if we can write to it, false otherwise.
405 bool can_write(const Twine &Path);
407 /// @brief Do file_status's represent the same thing?
409 /// @param A Input file_status.
410 /// @param B Input file_status.
412 /// assert(status_known(A) || status_known(B));
414 /// @returns True if A and B both represent the same file system entity, false
416 bool equivalent(file_status A, file_status B);
418 /// @brief Do paths represent the same thing?
420 /// assert(status_known(A) || status_known(B));
422 /// @param A Input path A.
423 /// @param B Input path B.
424 /// @param result Set to true if stat(A) and stat(B) have the same device and
425 /// inode (or equivalent).
426 /// @returns errc::success if result has been successfully set, otherwise a
427 /// platform specific error_code.
428 error_code equivalent(const Twine &A, const Twine &B, bool &result);
430 /// @brief Simpler version of equivalent for clients that don't need to
431 /// differentiate between an error and false.
432 inline bool equivalent(const Twine &A, const Twine &B) {
434 return !equivalent(A, B, result) && result;
437 /// @brief Get file size.
439 /// @param path Input path.
440 /// @param result Set to the size of the file in \a path.
441 /// @returns errc::success if result has been successfully set, otherwise a
442 /// platform specific error_code.
443 error_code file_size(const Twine &path, uint64_t &result);
445 /// @brief Does status represent a directory?
447 /// @param status A file_status previously returned from status.
448 /// @returns status.type() == file_type::directory_file.
449 bool is_directory(file_status status);
451 /// @brief Is path a directory?
453 /// @param path Input path.
454 /// @param result Set to true if \a path is a directory, false if it is not.
455 /// Undefined otherwise.
456 /// @returns errc::success if result has been successfully set, otherwise a
457 /// platform specific error_code.
458 error_code is_directory(const Twine &path, bool &result);
460 /// @brief Does status represent a regular file?
462 /// @param status A file_status previously returned from status.
463 /// @returns status_known(status) && status.type() == file_type::regular_file.
464 bool is_regular_file(file_status status);
466 /// @brief Is path a regular file?
468 /// @param path Input path.
469 /// @param result Set to true if \a path is a regular file, false if it is not.
470 /// Undefined otherwise.
471 /// @returns errc::success if result has been successfully set, otherwise a
472 /// platform specific error_code.
473 error_code is_regular_file(const Twine &path, bool &result);
475 /// @brief Simpler version of is_regular_file for clients that don't need to
476 /// differentiate between an error and false.
477 inline bool is_regular_file(const Twine &Path) {
479 if (is_regular_file(Path, Result))
484 /// @brief Does this status represent something that exists but is not a
485 /// directory, regular file, or symlink?
487 /// @param status A file_status previously returned from status.
488 /// @returns exists(s) && !is_regular_file(s) && !is_directory(s) &&
490 bool is_other(file_status status);
492 /// @brief Is path something that exists but is not a directory,
493 /// regular file, or symlink?
495 /// @param path Input path.
496 /// @param result Set to true if \a path exists, but is not a directory, regular
497 /// file, or a symlink, false if it does not. Undefined otherwise.
498 /// @returns errc::success if result has been successfully set, otherwise a
499 /// platform specific error_code.
500 error_code is_other(const Twine &path, bool &result);
502 /// @brief Does status represent a symlink?
504 /// @param status A file_status previously returned from stat.
505 /// @returns status.type() == symlink_file.
506 bool is_symlink(file_status status);
508 /// @brief Is path a symlink?
510 /// @param path Input path.
511 /// @param result Set to true if \a path is a symlink, false if it is not.
512 /// Undefined otherwise.
513 /// @returns errc::success if result has been successfully set, otherwise a
514 /// platform specific error_code.
515 error_code is_symlink(const Twine &path, bool &result);
517 /// @brief Get file status as if by POSIX stat().
519 /// @param path Input path.
520 /// @param result Set to the file status.
521 /// @returns errc::success if result has been successfully set, otherwise a
522 /// platform specific error_code.
523 error_code status(const Twine &path, file_status &result);
525 /// @brief Modifies permission bits on a file
527 /// @param path Input path.
528 /// @returns errc::success if permissions have been changed, otherwise a
529 /// platform specific error_code.
530 error_code permissions(const Twine &path, perms prms);
532 error_code setLastModificationAndAccessTime(int FD, TimeValue Time);
534 /// @brief Is status available?
536 /// @param s Input file status.
537 /// @returns True if status() != status_error.
538 bool status_known(file_status s);
540 /// @brief Is status available?
542 /// @param path Input path.
543 /// @param result Set to true if status() != status_error.
544 /// @returns errc::success if result has been successfully set, otherwise a
545 /// platform specific error_code.
546 error_code status_known(const Twine &path, bool &result);
548 /// @brief Generate a unique path and open it as a file.
550 /// Generates a unique path suitable for a temporary file and then opens it as a
551 /// file. The name is based on \a model with '%' replaced by a random char in
552 /// [0-9a-f]. If \a model is not an absolute path, a suitable temporary
553 /// directory will be prepended.
555 /// This is an atomic operation. Either the file is created and opened, or the
556 /// file system is left untouched.
558 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
560 /// @param model Name to base unique path off of.
561 /// @param result_fd Set to the opened file's file descriptor.
562 /// @param result_path Set to the opened file's absolute path.
563 /// @param makeAbsolute If true and \a model is not an absolute path, a temp
564 /// directory will be prepended.
565 /// @param mode Set to the file open mode; since this is most often used for
566 /// temporary files, mode defaults to owner_read | owner_write.
567 /// @returns errc::success if result_{fd,path} have been successfully set,
568 /// otherwise a platform specific error_code.
569 error_code unique_file(const Twine &model, int &result_fd,
570 SmallVectorImpl<char> &result_path,
571 bool makeAbsolute = true,
572 unsigned mode = owner_read | owner_write);
574 /// @brief Simpler version for clients that don't want an open file.
575 error_code unique_file(const Twine &Model, SmallVectorImpl<char> &ResultPath,
576 bool MakeAbsolute = true);
578 /// @brief Create a file in the system temporary directory.
580 /// The filename is of the form prefix-random_chars.suffix. Since the directory
581 /// is not know to the caller, Prefix and Suffix cannot have path separators.
582 /// The files are created with mode 0600.
584 /// This should be used for things like a temporary .s that is removed after
585 /// running the assembler.
586 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
588 SmallVectorImpl<char> &ResultPath);
590 /// @brief Simpler version for clients that don't want an open file.
591 error_code createTemporaryFile(const Twine &Prefix, StringRef Suffix,
592 SmallVectorImpl<char> &ResultPath);
594 error_code createUniqueDirectory(const Twine &Prefix,
595 SmallVectorImpl<char> &ResultPath);
597 /// @brief Canonicalize path.
599 /// Sets result to the file system's idea of what path is. The result is always
600 /// absolute and has the same capitalization as the file system.
602 /// @param path Input path.
603 /// @param result Set to the canonicalized version of \a path.
604 /// @returns errc::success if result has been successfully set, otherwise a
605 /// platform specific error_code.
606 error_code canonicalize(const Twine &path, SmallVectorImpl<char> &result);
608 /// @brief Are \a path's first bytes \a magic?
610 /// @param path Input path.
611 /// @param magic Byte sequence to compare \a path's first len(magic) bytes to.
612 /// @returns errc::success if result has been successfully set, otherwise a
613 /// platform specific error_code.
614 error_code has_magic(const Twine &path, const Twine &magic, bool &result);
616 /// @brief Get \a path's first \a len bytes.
618 /// @param path Input path.
619 /// @param len Number of magic bytes to get.
620 /// @param result Set to the first \a len bytes in the file pointed to by
621 /// \a path. Or the entire file if file_size(path) < len, in which
622 /// case result.size() returns the size of the file.
623 /// @returns errc::success if result has been successfully set,
624 /// errc::value_too_large if len is larger then the file pointed to by
625 /// \a path, otherwise a platform specific error_code.
626 error_code get_magic(const Twine &path, uint32_t len,
627 SmallVectorImpl<char> &result);
629 /// @brief Identify the type of a binary file based on how magical it is.
630 file_magic identify_magic(StringRef magic);
632 /// @brief Get and identify \a path's type based on its content.
634 /// @param path Input path.
635 /// @param result Set to the type of file, or file_magic::unknown.
636 /// @returns errc::success if result has been successfully set, otherwise a
637 /// platform specific error_code.
638 error_code identify_magic(const Twine &path, file_magic &result);
640 error_code getUniqueID(const Twine Path, uint64_t &Result);
642 /// This class represents a memory mapped file. It is based on
643 /// boost::iostreams::mapped_file.
644 class mapped_file_region {
645 mapped_file_region() LLVM_DELETED_FUNCTION;
646 mapped_file_region(mapped_file_region&) LLVM_DELETED_FUNCTION;
647 mapped_file_region &operator =(mapped_file_region&) LLVM_DELETED_FUNCTION;
651 readonly, ///< May only access map via const_data as read only.
652 readwrite, ///< May access map via data and modify it. Written to path.
653 priv ///< May modify via data, but changes are lost on destruction.
657 /// Platform specific mapping state.
664 void *FileMappingHandle;
667 error_code init(int FD, bool CloseFD, uint64_t Offset);
670 typedef char char_type;
672 #if LLVM_HAS_RVALUE_REFERENCES
673 mapped_file_region(mapped_file_region&&);
674 mapped_file_region &operator =(mapped_file_region&&);
677 /// Construct a mapped_file_region at \a path starting at \a offset of length
678 /// \a length and with access \a mode.
680 /// \param path Path to the file to map. If it does not exist it will be
682 /// \param mode How to map the memory.
683 /// \param length Number of bytes to map in starting at \a offset. If the file
684 /// is shorter than this, it will be extended. If \a length is
685 /// 0, the entire file will be mapped.
686 /// \param offset Byte offset from the beginning of the file where the map
687 /// should begin. Must be a multiple of
688 /// mapped_file_region::alignment().
689 /// \param ec This is set to errc::success if the map was constructed
690 /// sucessfully. Otherwise it is set to a platform dependent error.
691 mapped_file_region(const Twine &path,
697 /// \param fd An open file descriptor to map. mapped_file_region takes
698 /// ownership if closefd is true. It must have been opended in the correct
700 mapped_file_region(int fd,
707 ~mapped_file_region();
709 mapmode flags() const;
710 uint64_t size() const;
713 /// Get a const view of the data. Modifying this memory has undefined
715 const char *const_data() const;
717 /// \returns The minimum alignment offset must be.
718 static int alignment();
721 /// @brief Memory maps the contents of a file
723 /// @param path Path to file to map.
724 /// @param file_offset Byte offset in file where mapping should begin.
725 /// @param size Byte length of range of the file to map.
726 /// @param map_writable If true, the file will be mapped in r/w such
727 /// that changes to the mapped buffer will be flushed back
728 /// to the file. If false, the file will be mapped read-only
729 /// and the buffer will be read-only.
730 /// @param result Set to the start address of the mapped buffer.
731 /// @returns errc::success if result has been successfully set, otherwise a
732 /// platform specific error_code.
733 error_code map_file_pages(const Twine &path, off_t file_offset, size_t size,
734 bool map_writable, void *&result);
737 /// @brief Memory unmaps the contents of a file
739 /// @param base Pointer to the start of the buffer.
740 /// @param size Byte length of the range to unmmap.
741 /// @returns errc::success if result has been successfully set, otherwise a
742 /// platform specific error_code.
743 error_code unmap_file_pages(void *base, size_t size);
745 /// Return the path to the main executable, given the value of argv[0] from
746 /// program startup and the address of main itself. In extremis, this function
747 /// may fail and return an empty path.
748 std::string getMainExecutable(const char *argv0, void *MainExecAddr);
754 /// directory_entry - A single entry in a directory. Caches the status either
755 /// from the result of the iteration syscall, or the first time status is
757 class directory_entry {
759 mutable file_status Status;
762 explicit directory_entry(const Twine &path, file_status st = file_status())
768 void assign(const Twine &path, file_status st = file_status()) {
773 void replace_filename(const Twine &filename, file_status st = file_status());
775 const std::string &path() const { return Path; }
776 error_code status(file_status &result) const;
778 bool operator==(const directory_entry& rhs) const { return Path == rhs.Path; }
779 bool operator!=(const directory_entry& rhs) const { return !(*this == rhs); }
780 bool operator< (const directory_entry& rhs) const;
781 bool operator<=(const directory_entry& rhs) const;
782 bool operator> (const directory_entry& rhs) const;
783 bool operator>=(const directory_entry& rhs) const;
789 error_code directory_iterator_construct(DirIterState&, StringRef);
790 error_code directory_iterator_increment(DirIterState&);
791 error_code directory_iterator_destruct(DirIterState&);
793 /// DirIterState - Keeps state for the directory_iterator. It is reference
794 /// counted in order to preserve InputIterator semantics on copy.
795 struct DirIterState : public RefCountedBase<DirIterState> {
797 : IterationHandle(0) {}
800 directory_iterator_destruct(*this);
803 intptr_t IterationHandle;
804 directory_entry CurrentEntry;
808 /// directory_iterator - Iterates through the entries in path. There is no
809 /// operator++ because we need an error_code. If it's really needed we can make
810 /// it call report_fatal_error on error.
811 class directory_iterator {
812 IntrusiveRefCntPtr<detail::DirIterState> State;
815 explicit directory_iterator(const Twine &path, error_code &ec) {
816 State = new detail::DirIterState;
817 SmallString<128> path_storage;
818 ec = detail::directory_iterator_construct(*State,
819 path.toStringRef(path_storage));
822 explicit directory_iterator(const directory_entry &de, error_code &ec) {
823 State = new detail::DirIterState;
824 ec = detail::directory_iterator_construct(*State, de.path());
827 /// Construct end iterator.
828 directory_iterator() : State(new detail::DirIterState) {}
830 // No operator++ because we need error_code.
831 directory_iterator &increment(error_code &ec) {
832 ec = directory_iterator_increment(*State);
836 const directory_entry &operator*() const { return State->CurrentEntry; }
837 const directory_entry *operator->() const { return &State->CurrentEntry; }
839 bool operator==(const directory_iterator &RHS) const {
840 return State->CurrentEntry == RHS.State->CurrentEntry;
843 bool operator!=(const directory_iterator &RHS) const {
844 return !(*this == RHS);
846 // Other members as required by
847 // C++ Std, 24.1.1 Input iterators [input.iterators]
851 /// RecDirIterState - Keeps state for the recursive_directory_iterator. It is
852 /// reference counted in order to preserve InputIterator semantics on copy.
853 struct RecDirIterState : public RefCountedBase<RecDirIterState> {
856 , HasNoPushRequest(false) {}
858 std::stack<directory_iterator, std::vector<directory_iterator> > Stack;
860 bool HasNoPushRequest;
864 /// recursive_directory_iterator - Same as directory_iterator except for it
865 /// recurses down into child directories.
866 class recursive_directory_iterator {
867 IntrusiveRefCntPtr<detail::RecDirIterState> State;
870 recursive_directory_iterator() {}
871 explicit recursive_directory_iterator(const Twine &path, error_code &ec)
872 : State(new detail::RecDirIterState) {
873 State->Stack.push(directory_iterator(path, ec));
874 if (State->Stack.top() == directory_iterator())
877 // No operator++ because we need error_code.
878 recursive_directory_iterator &increment(error_code &ec) {
879 static const directory_iterator end_itr;
881 if (State->HasNoPushRequest)
882 State->HasNoPushRequest = false;
885 if ((ec = State->Stack.top()->status(st))) return *this;
886 if (is_directory(st)) {
887 State->Stack.push(directory_iterator(*State->Stack.top(), ec));
888 if (ec) return *this;
889 if (State->Stack.top() != end_itr) {
897 while (!State->Stack.empty()
898 && State->Stack.top().increment(ec) == end_itr) {
903 // Check if we are done. If so, create an end iterator.
904 if (State->Stack.empty())
910 const directory_entry &operator*() const { return *State->Stack.top(); }
911 const directory_entry *operator->() const { return &*State->Stack.top(); }
914 /// Gets the current level. Starting path is at level 0.
915 int level() const { return State->Level; }
917 /// Returns true if no_push has been called for this directory_entry.
918 bool no_push_request() const { return State->HasNoPushRequest; }
921 /// Goes up one level if Level > 0.
923 assert(State && "Cannot pop and end itertor!");
924 assert(State->Level > 0 && "Cannot pop an iterator with level < 1");
926 static const directory_iterator end_itr;
930 report_fatal_error("Error incrementing directory iterator.");
933 } while (!State->Stack.empty()
934 && State->Stack.top().increment(ec) == end_itr);
936 // Check if we are done. If so, create an end iterator.
937 if (State->Stack.empty())
941 /// Does not go down into the current directory_entry.
942 void no_push() { State->HasNoPushRequest = true; }
944 bool operator==(const recursive_directory_iterator &RHS) const {
945 return State == RHS.State;
948 bool operator!=(const recursive_directory_iterator &RHS) const {
949 return !(*this == RHS);
951 // Other members as required by
952 // C++ Std, 24.1.1 Input iterators [input.iterators]
957 } // end namespace fs
958 } // end namespace sys
959 } // end namespace llvm