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 _LIBCPP_PUSH_MACROS 32 #include <__undef_macros> 33 34 #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM) 35 36 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM 37 38 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH 39 40 class recursive_directory_iterator { 41 public: 42 using value_type = directory_entry; 43 using difference_type = ptrdiff_t; 44 using pointer = directory_entry const*; 45 using reference = directory_entry const&; 46 using iterator_category = input_iterator_tag; 47 48 public: 49 // constructors and destructor 50 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator() noexcept : __rec_(false) {} 51 52 _LIBCPP_HIDE_FROM_ABI explicit recursive_directory_iterator( 53 const path& __p, directory_options __xoptions = directory_options::none) 54 : recursive_directory_iterator(__p, __xoptions, nullptr) {} 55 56 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __xoptions, error_code& __ec) 57 : recursive_directory_iterator(__p, __xoptions, &__ec) {} 58 59 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, error_code& __ec) 60 : recursive_directory_iterator(__p, directory_options::none, &__ec) {} 61 62 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const recursive_directory_iterator&) = default; 63 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(recursive_directory_iterator&&) = default; 64 65 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(const recursive_directory_iterator&) = default; 66 67 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(recursive_directory_iterator&& __o) noexcept { 68 // non-default implementation provided to support self-move assign. 69 if (this != &__o) { 70 __imp_ = std::move(__o.__imp_); 71 __rec_ = __o.__rec_; 72 } 73 return *this; 74 } 75 76 _LIBCPP_HIDE_FROM_ABI ~recursive_directory_iterator() = default; 77 78 _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const { return __dereference(); } 79 80 _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &__dereference(); } 81 82 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator++() { return __increment(); } 83 84 _LIBCPP_HIDE_FROM_ABI __dir_element_proxy operator++(int) { 85 __dir_element_proxy __p(**this); 86 __increment(); 87 return __p; 88 } 89 90 _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& increment(error_code& __ec) { return __increment(&__ec); } 91 92 _LIBCPP_EXPORTED_FROM_ABI directory_options options() const; 93 _LIBCPP_EXPORTED_FROM_ABI int depth() const; 94 95 _LIBCPP_HIDE_FROM_ABI void pop() { __pop(); } 96 97 _LIBCPP_HIDE_FROM_ABI void pop(error_code& __ec) { __pop(&__ec); } 98 99 _LIBCPP_HIDE_FROM_ABI bool recursion_pending() const { return __rec_; } 100 101 _LIBCPP_HIDE_FROM_ABI void disable_recursion_pending() { __rec_ = false; } 102 103 # if _LIBCPP_STD_VER >= 20 104 105 _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept { 106 return *this == recursive_directory_iterator(); 107 } 108 109 # endif 110 111 private: 112 _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __opt, error_code* __ec); 113 _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const; 114 _LIBCPP_EXPORTED_FROM_ABI bool __try_recursion(error_code* __ec); 115 _LIBCPP_EXPORTED_FROM_ABI void __advance(error_code* __ec = nullptr); 116 _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator& __increment(error_code* __ec = nullptr); 117 _LIBCPP_EXPORTED_FROM_ABI void __pop(error_code* __ec = nullptr); 118 119 inline _LIBCPP_HIDE_FROM_ABI friend bool 120 operator==(const recursive_directory_iterator&, const recursive_directory_iterator&) noexcept; 121 122 struct _LIBCPP_HIDDEN __shared_imp; 123 shared_ptr<__shared_imp> __imp_; 124 bool __rec_; 125 }; // class recursive_directory_iterator 126 127 inline _LIBCPP_HIDE_FROM_ABI bool 128 operator==(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept { 129 return __lhs.__imp_ == __rhs.__imp_; 130 } 131 132 _LIBCPP_HIDE_FROM_ABI inline bool 133 operator!=(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept { 134 return !(__lhs == __rhs); 135 } 136 // enable recursive_directory_iterator range-based for statements 137 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator begin(recursive_directory_iterator __iter) noexcept { 138 return __iter; 139 } 140 141 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator end(recursive_directory_iterator) noexcept { 142 return recursive_directory_iterator(); 143 } 144 145 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP 146 147 _LIBCPP_END_NAMESPACE_FILESYSTEM 148 149 # if _LIBCPP_STD_VER >= 20 150 151 template <> 152 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool 153 std::ranges::enable_borrowed_range<std::filesystem::recursive_directory_iterator> = true; 154 155 template <> 156 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool 157 std::ranges::enable_view<std::filesystem::recursive_directory_iterator> = true; 158 159 # endif // _LIBCPP_STD_VER >= 20 160 161 #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM) 162 163 _LIBCPP_POP_MACROS 164 165 #endif // _LIBCPP___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H 166