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 <__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
26#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
27# pragma GCC system_header
28#endif
29
30_LIBCPP_PUSH_MACROS
31#include <__undef_macros>
32
33#if _LIBCPP_STD_VER >= 17 && _LIBCPP_HAS_FILESYSTEM
34
35_LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
36_LIBCPP_BEGIN_EXPLICIT_ABI_ANNOTATIONS
37
38class _LIBCPP_HIDDEN __dir_stream;
39class directory_iterator {
40public:
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
47public:
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 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const {
76 // Note: this check duplicates a check in `__dereference()`.
77 _LIBCPP_ASSERT_NON_NULL(__imp_, "The end iterator cannot be dereferenced");
78 return __dereference();
79 }
80
81 _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &**this; }
82
83 _LIBCPP_HIDE_FROM_ABI directory_iterator& operator++() { return __increment(); }
84
85 _LIBCPP_HIDE_FROM_ABI __dir_element_proxy operator++(int) {
86 __dir_element_proxy __p(**this);
87 __increment();
88 return __p;
89 }
90
91 _LIBCPP_HIDE_FROM_ABI directory_iterator& increment(error_code& __ec) { return __increment(ec: &__ec); }
92
93# if _LIBCPP_STD_VER >= 20
94
95 _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept { return *this == directory_iterator(); }
96
97# endif
98
99private:
100 inline _LIBCPP_HIDE_FROM_ABI friend bool
101 operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept;
102
103 // construct the dir_stream
104 _LIBCPP_EXPORTED_FROM_ABI directory_iterator(const path&, error_code*, directory_options = directory_options::none);
105
106 _LIBCPP_EXPORTED_FROM_ABI directory_iterator& __increment(error_code* __ec = nullptr);
107
108 _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const;
109
110private:
111 shared_ptr<__dir_stream> __imp_;
112};
113
114inline _LIBCPP_HIDE_FROM_ABI bool
115operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
116 return __lhs.__imp_ == __rhs.__imp_;
117}
118
119inline _LIBCPP_HIDE_FROM_ABI bool
120operator!=(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
121 return !(__lhs == __rhs);
122}
123
124// enable directory_iterator range-based for statements
125[[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI directory_iterator begin(directory_iterator __iter) noexcept {
126 return __iter;
127}
128
129[[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI directory_iterator end(directory_iterator) noexcept {
130 return directory_iterator();
131}
132
133_LIBCPP_END_EXPLICIT_ABI_ANNOTATIONS
134_LIBCPP_END_NAMESPACE_FILESYSTEM
135
136# if _LIBCPP_STD_VER >= 20
137
138template <>
139inline constexpr bool std::ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;
140
141template <>
142inline constexpr bool std::ranges::enable_view<std::filesystem::directory_iterator> = true;
143
144# endif // _LIBCPP_STD_VER >= 20
145
146#endif // _LIBCPP_STD_VER >= 17 && _LIBCPP_HAS_FILESYSTEM
147
148_LIBCPP_POP_MACROS
149
150#endif // _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
151