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
37class _LIBCPP_HIDDEN __dir_stream;
38class directory_iterator {
39public:
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
46public:
47 // ctor & dtor
48 _LIBCPP_HIDE_FROM_ABI directory_iterator() noexcept {}
49
50 _LIBCPP_HIDE_FROM_ABI explicit directory_iterator(const path& __p) : directory_iterator(__p, nullptr) {}
51
52 _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts)
53 : directory_iterator(__p, nullptr, __opts) {}
54
55 _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, error_code& __ec) : directory_iterator(__p, &__ec) {}
56
57 _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts, error_code& __ec)
58 : directory_iterator(__p, &__ec, __opts) {}
59
60 _LIBCPP_HIDE_FROM_ABI directory_iterator(const directory_iterator&) = default;
61 _LIBCPP_HIDE_FROM_ABI directory_iterator(directory_iterator&&) = default;
62 _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(const directory_iterator&) = default;
63
64 _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(directory_iterator&& __o) noexcept {
65 // non-default implementation provided to support self-move assign.
66 if (this != &__o) {
67 __imp_ = std::move(__o.__imp_);
68 }
69 return *this;
70 }
71
72 _LIBCPP_HIDE_FROM_ABI ~directory_iterator() = default;
73
74 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const {
75 // Note: this check duplicates a check in `__dereference()`.
76 _LIBCPP_ASSERT_NON_NULL(__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: &__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
98private:
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
109private:
110 shared_ptr<__dir_stream> __imp_;
111};
112
113inline _LIBCPP_HIDE_FROM_ABI bool
114operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
115 return __lhs.__imp_ == __rhs.__imp_;
116}
117
118inline _LIBCPP_HIDE_FROM_ABI bool
119operator!=(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
120 return !(__lhs == __rhs);
121}
122
123// enable directory_iterator range-based for statements
124[[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI directory_iterator begin(directory_iterator __iter) noexcept {
125 return __iter;
126}
127
128[[nodiscard]] inline _LIBCPP_HIDE_FROM_ABI directory_iterator end(directory_iterator) noexcept {
129 return directory_iterator();
130}
131
132_LIBCPP_END_NAMESPACE_FILESYSTEM
133
134# if _LIBCPP_STD_VER >= 20
135
136template <>
137inline constexpr bool std::ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;
138
139template <>
140inline constexpr bool std::ranges::enable_view<std::filesystem::directory_iterator> = true;
141
142# endif // _LIBCPP_STD_VER >= 20
143
144#endif // _LIBCPP_STD_VER >= 17 && _LIBCPP_HAS_FILESYSTEM
145
146_LIBCPP_POP_MACROS
147
148#endif // _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
149