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