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_DIRECTORY_ITERATOR_H
11 #define _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
12 
13 #include <__assert>
14 #include <__availability>
15 #include <__config>
16 #include <__filesystem/directory_entry.h>
17 #include <__filesystem/directory_options.h>
18 #include <__filesystem/path.h>
19 #include <__iterator/default_sentinel.h>
20 #include <__iterator/iterator_traits.h>
21 #include <__memory/shared_ptr.h>
22 #include <__ranges/enable_borrowed_range.h>
23 #include <__ranges/enable_view.h>
24 #include <__system_error/error_code.h>
25 #include <__utility/move.h>
26 #include <cstddef>
27 
28 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
29 #  pragma GCC system_header
30 #endif
31 
32 #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
33 
34 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
35 
36 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH
37 
38 class _LIBCPP_HIDDEN __dir_stream;
39 class directory_iterator {
40 public:
41   typedef directory_entry value_type;
42   typedef ptrdiff_t difference_type;
43   typedef value_type const* pointer;
44   typedef value_type const& reference;
45   typedef input_iterator_tag iterator_category;
46 
47 public:
48   // ctor & dtor
49   _LIBCPP_HIDE_FROM_ABI directory_iterator() noexcept {}
50 
51   _LIBCPP_HIDE_FROM_ABI explicit directory_iterator(const path& __p) : directory_iterator(__p, nullptr) {}
52 
53   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts)
54       : directory_iterator(__p, nullptr, __opts) {}
55 
56   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, error_code& __ec) : directory_iterator(__p, &__ec) {}
57 
58   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts, error_code& __ec)
59       : directory_iterator(__p, &__ec, __opts) {}
60 
61   _LIBCPP_HIDE_FROM_ABI directory_iterator(const directory_iterator&)            = default;
62   _LIBCPP_HIDE_FROM_ABI directory_iterator(directory_iterator&&)                 = default;
63   _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(const directory_iterator&) = default;
64 
65   _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(directory_iterator&& __o) noexcept {
66     // non-default implementation provided to support self-move assign.
67     if (this != &__o) {
68       __imp_ = std::move(__o.__imp_);
69     }
70     return *this;
71   }
72 
73   _LIBCPP_HIDE_FROM_ABI ~directory_iterator() = default;
74 
75   _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const {
76     _LIBCPP_ASSERT_UNCATEGORIZED(__imp_, "The end iterator cannot be dereferenced");
77     return __dereference();
78   }
79 
80   _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &**this; }
81 
82   _LIBCPP_HIDE_FROM_ABI 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 directory_iterator& increment(error_code& __ec) { return __increment(&__ec); }
91 
92 #  if _LIBCPP_STD_VER >= 20
93 
94   _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept { return *this == directory_iterator(); }
95 
96 #  endif
97 
98 private:
99   inline _LIBCPP_HIDE_FROM_ABI friend bool
100   operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept;
101 
102   // construct the dir_stream
103   _LIBCPP_EXPORTED_FROM_ABI directory_iterator(const path&, error_code*, directory_options = directory_options::none);
104 
105   _LIBCPP_EXPORTED_FROM_ABI directory_iterator& __increment(error_code* __ec = nullptr);
106 
107   _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const;
108 
109 private:
110   shared_ptr<__dir_stream> __imp_;
111 };
112 
113 inline _LIBCPP_HIDE_FROM_ABI bool
114 operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
115   return __lhs.__imp_ == __rhs.__imp_;
116 }
117 
118 inline _LIBCPP_HIDE_FROM_ABI bool
119 operator!=(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
120   return !(__lhs == __rhs);
121 }
122 
123 // enable directory_iterator range-based for statements
124 inline _LIBCPP_HIDE_FROM_ABI directory_iterator begin(directory_iterator __iter) noexcept { return __iter; }
125 
126 inline _LIBCPP_HIDE_FROM_ABI directory_iterator end(directory_iterator) noexcept { return directory_iterator(); }
127 
128 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
129 
130 _LIBCPP_END_NAMESPACE_FILESYSTEM
131 
132 #  if _LIBCPP_STD_VER >= 20
133 
134 template <>
135 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
136     std::ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;
137 
138 template <>
139 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
140     std::ranges::enable_view<std::filesystem::directory_iterator> = true;
141 
142 #  endif // _LIBCPP_STD_VER >= 20
143 
144 #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
145 
146 #endif // _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
147