1 // -*- C++ -*- 2 //===----------------------------------------------------------------------===// 3 // 4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 5 // See https://llvm.org/LICENSE.txt for license information. 6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7 // 8 //===----------------------------------------------------------------------===// 9 10 #ifndef _LIBCPP___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H 11 #define _LIBCPP___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H 12 13 #include <__availability> 14 #include <__config> 15 #include <__filesystem/directory_entry.h> 16 #include <__filesystem/directory_options.h> 17 #include <__filesystem/path.h> 18 #include <__iterator/default_sentinel.h> 19 #include <__iterator/iterator_traits.h> 20 #include <__memory/shared_ptr.h> 21 #include <__ranges/enable_borrowed_range.h> 22 #include <__ranges/enable_view.h> 23 #include <__system_error/error_code.h> 24 #include <__utility/move.h> 25 #include <cstddef> 26 27 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER) 28 # pragma GCC system_header 29 #endif 30 31 #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM) 32 33 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM 34 35 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH 36 37 class recursive_directory_iterator { 38 public: 39 using value_type = directory_entry; 40 using difference_type = ptrdiff_t; 41 using pointer = directory_entry const*; 42 using reference = directory_entry const&; 43 using iterator_category = input_iterator_tag; 44 45 public: 46 // constructors and destructor 47 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator() noexcept : __rec_(false) {} 48 49 _LIBCPP_HIDE_FROM_ABI explicit recursive_directory_iterator( 50 const path& __p, directory_options __xoptions = directory_options::none) 51 : recursive_directory_iterator(__p, __xoptions, nullptr) {} 52 53 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __xoptions, error_code& __ec) 54 : recursive_directory_iterator(__p, __xoptions, &__ec) {} 55 56 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, error_code& __ec) 57 : recursive_directory_iterator(__p, directory_options::none, &__ec) {} 58 59 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const recursive_directory_iterator&) = default; 60 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(recursive_directory_iterator&&) = default; 61 62 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(const recursive_directory_iterator&) = default; 63 64 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(recursive_directory_iterator&& __o) noexcept { 65 // non-default implementation provided to support self-move assign. 66 if (this != &__o) { 67 __imp_ = std::move(__o.__imp_); 68 __rec_ = __o.__rec_; 69 } 70 return *this; 71 } 72 73 _LIBCPP_HIDE_FROM_ABI ~recursive_directory_iterator() = default; 74 75 _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const { return __dereference(); } 76 77 _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &__dereference(); } 78 79 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator++() { return __increment(); } 80 81 _LIBCPP_HIDE_FROM_ABI __dir_element_proxy operator++(int) { 82 __dir_element_proxy __p(**this); 83 __increment(); 84 return __p; 85 } 86 87 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& increment(error_code& __ec) { return __increment(&__ec); } 88 89 _LIBCPP_EXPORTED_FROM_ABI directory_options options() const; 90 _LIBCPP_EXPORTED_FROM_ABI int depth() const; 91 92 _LIBCPP_HIDE_FROM_ABI void pop() { __pop(); } 93 94 _LIBCPP_HIDE_FROM_ABI void pop(error_code& __ec) { __pop(&__ec); } 95 96 _LIBCPP_HIDE_FROM_ABI bool recursion_pending() const { return __rec_; } 97 98 _LIBCPP_HIDE_FROM_ABI void disable_recursion_pending() { __rec_ = false; } 99 100 # if _LIBCPP_STD_VER >= 20 101 102 _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept { 103 return *this == recursive_directory_iterator(); 104 } 105 106 # endif 107 108 private: 109 _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __opt, error_code* __ec); 110 _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const; 111 _LIBCPP_EXPORTED_FROM_ABI bool __try_recursion(error_code* __ec); 112 _LIBCPP_EXPORTED_FROM_ABI void __advance(error_code* __ec = nullptr); 113 _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator& __increment(error_code* __ec = nullptr); 114 _LIBCPP_EXPORTED_FROM_ABI void __pop(error_code* __ec = nullptr); 115 116 inline _LIBCPP_HIDE_FROM_ABI friend bool 117 operator==(const recursive_directory_iterator&, const recursive_directory_iterator&) noexcept; 118 119 struct _LIBCPP_HIDDEN __shared_imp; 120 shared_ptr<__shared_imp> __imp_; 121 bool __rec_; 122 }; // class recursive_directory_iterator 123 124 inline _LIBCPP_HIDE_FROM_ABI bool 125 operator==(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept { 126 return __lhs.__imp_ == __rhs.__imp_; 127 } 128 129 _LIBCPP_HIDE_FROM_ABI inline bool 130 operator!=(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept { 131 return !(__lhs == __rhs); 132 } 133 // enable recursive_directory_iterator range-based for statements 134 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator begin(recursive_directory_iterator __iter) noexcept { 135 return __iter; 136 } 137 138 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator end(recursive_directory_iterator) noexcept { 139 return recursive_directory_iterator(); 140 } 141 142 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP 143 144 _LIBCPP_END_NAMESPACE_FILESYSTEM 145 146 # if _LIBCPP_STD_VER >= 20 147 148 template <> 149 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool 150 std::ranges::enable_borrowed_range<std::filesystem::recursive_directory_iterator> = true; 151 152 template <> 153 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool 154 std::ranges::enable_view<std::filesystem::recursive_directory_iterator> = true; 155 156 # endif // _LIBCPP_STD_VER >= 20 157 158 #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM) 159 160 #endif // _LIBCPP___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H 161