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/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 #ifndef _LIBCPP_CXX03_LANG
32
33 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
34
35 _LIBCPP_AVAILABILITY_FILESYSTEM_PUSH
36
37 class _LIBCPP_HIDDEN __dir_stream;
38 class directory_iterator {
39 public:
40 typedef directory_entry value_type;
41 typedef ptrdiff_t difference_type;
42 typedef value_type const* pointer;
43 typedef value_type const& reference;
44 typedef input_iterator_tag iterator_category;
45
46 public:
47 //ctor & dtor
48 _LIBCPP_HIDE_FROM_ABI
directory_iterator()49 directory_iterator() noexcept {}
50
51 _LIBCPP_HIDE_FROM_ABI
directory_iterator(const path & __p)52 explicit directory_iterator(const path& __p)
53 : directory_iterator(__p, nullptr) {}
54
55 _LIBCPP_HIDE_FROM_ABI
directory_iterator(const path & __p,directory_options __opts)56 directory_iterator(const path& __p, directory_options __opts)
57 : directory_iterator(__p, nullptr, __opts) {}
58
59 _LIBCPP_HIDE_FROM_ABI
directory_iterator(const path & __p,error_code & __ec)60 directory_iterator(const path& __p, error_code& __ec)
61 : directory_iterator(__p, &__ec) {}
62
63 _LIBCPP_HIDE_FROM_ABI
directory_iterator(const path & __p,directory_options __opts,error_code & __ec)64 directory_iterator(const path& __p, directory_options __opts,
65 error_code& __ec)
66 : directory_iterator(__p, &__ec, __opts) {}
67
68 _LIBCPP_HIDE_FROM_ABI directory_iterator(const directory_iterator&) = default;
69 _LIBCPP_HIDE_FROM_ABI directory_iterator(directory_iterator&&) = default;
70 _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(const directory_iterator&) = default;
71
72 _LIBCPP_HIDE_FROM_ABI
73 directory_iterator& operator=(directory_iterator&& __o) noexcept {
74 // non-default implementation provided to support self-move assign.
75 if (this != &__o) {
76 __imp_ = _VSTD::move(__o.__imp_);
77 }
78 return *this;
79 }
80
81 _LIBCPP_HIDE_FROM_ABI ~directory_iterator() = default;
82
83 _LIBCPP_HIDE_FROM_ABI
84 const directory_entry& operator*() const {
85 _LIBCPP_ASSERT(__imp_, "The end iterator cannot be dereferenced");
86 return __dereference();
87 }
88
89 _LIBCPP_HIDE_FROM_ABI
90 const directory_entry* operator->() const { return &**this; }
91
92 _LIBCPP_HIDE_FROM_ABI
93 directory_iterator& operator++() { return __increment(); }
94
95 _LIBCPP_HIDE_FROM_ABI
96 __dir_element_proxy operator++(int) {
97 __dir_element_proxy __p(**this);
98 __increment();
99 return __p;
100 }
101
102 _LIBCPP_HIDE_FROM_ABI
increment(error_code & __ec)103 directory_iterator& increment(error_code& __ec) { return __increment(&__ec); }
104
105 private:
106 inline _LIBCPP_HIDE_FROM_ABI friend bool
107 operator==(const directory_iterator& __lhs,
108 const directory_iterator& __rhs) noexcept;
109
110 // construct the dir_stream
111 _LIBCPP_FUNC_VIS
112 directory_iterator(const path&, error_code*,
113 directory_options = directory_options::none);
114
115 _LIBCPP_FUNC_VIS
116 directory_iterator& __increment(error_code* __ec = nullptr);
117
118 _LIBCPP_FUNC_VIS
119 const directory_entry& __dereference() const;
120
121 private:
122 shared_ptr<__dir_stream> __imp_;
123 };
124
125 inline _LIBCPP_HIDE_FROM_ABI bool
126 operator==(const directory_iterator& __lhs,
127 const directory_iterator& __rhs) noexcept {
128 return __lhs.__imp_ == __rhs.__imp_;
129 }
130
131 inline _LIBCPP_HIDE_FROM_ABI bool
132 operator!=(const directory_iterator& __lhs,
133 const directory_iterator& __rhs) noexcept {
134 return !(__lhs == __rhs);
135 }
136
137 // enable directory_iterator range-based for statements
138 inline _LIBCPP_HIDE_FROM_ABI directory_iterator
begin(directory_iterator __iter)139 begin(directory_iterator __iter) noexcept {
140 return __iter;
141 }
142
143 inline _LIBCPP_HIDE_FROM_ABI directory_iterator
end(directory_iterator)144 end(directory_iterator) noexcept {
145 return directory_iterator();
146 }
147
148 _LIBCPP_AVAILABILITY_FILESYSTEM_POP
149
150 _LIBCPP_END_NAMESPACE_FILESYSTEM
151
152 #if _LIBCPP_STD_VER >= 20
153
154 template <>
155 _LIBCPP_AVAILABILITY_FILESYSTEM
156 inline constexpr bool _VSTD::ranges::enable_borrowed_range<_VSTD_FS::directory_iterator> = true;
157
158 template <>
159 _LIBCPP_AVAILABILITY_FILESYSTEM
160 inline constexpr bool _VSTD::ranges::enable_view<_VSTD_FS::directory_iterator> = true;
161
162 #endif // _LIBCPP_STD_VER >= 20
163
164 #endif // _LIBCPP_CXX03_LANG
165
166 #endif // _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
167