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