v1/__filesystem/directory_iterator.h

0001 // -*- C++ -*-
0002 //===----------------------------------------------------------------------===//
0003 //
0004 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0005 // See https://llvm.org/LICENSE.txt for license information.
0006 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0007 //
0008 //===----------------------------------------------------------------------===//
0009
0010 #ifndef _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
0011 #define _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H
0012
0013 #include <__assert>
0014 #include <__config>
0015 #include <__filesystem/directory_entry.h>
0016 #include <__filesystem/directory_options.h>
0017 #include <__filesystem/path.h>
0018 #include <__iterator/default_sentinel.h>
0019 #include <__iterator/iterator_traits.h>
0020 #include <__memory/shared_ptr.h>
0021 #include <__ranges/enable_borrowed_range.h>
0022 #include <__ranges/enable_view.h>
0023 #include <__system_error/error_code.h>
0024 #include <__utility/move.h>
0025
0026 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
0027 #  pragma GCC system_header
0028 #endif
0029
0030 _LIBCPP_PUSH_MACROS
0031 #include <__undef_macros>
0032
0033 #if _LIBCPP_STD_VER >= 17 && _LIBCPP_HAS_FILESYSTEM
0034
0035 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
0036
0037 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH
0038
0039 class _LIBCPP_HIDDEN __dir_stream;
0040 class directory_iterator {
0041 public:
0042   typedef directory_entry value_type;
0043   typedef ptrdiff_t difference_type;
0044   typedef value_type const* pointer;
0045   typedef value_type const& reference;
0046   typedef input_iterator_tag iterator_category;
0047
0048 public:
0049   // ctor & dtor
0050   _LIBCPP_HIDE_FROM_ABI directory_iterator() noexcept {}
0051
0052   _LIBCPP_HIDE_FROM_ABI explicit directory_iterator(const path& __p) : directory_iterator(__p, nullptr) {}
0053
0054   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts)
0055       : directory_iterator(__p, nullptr, __opts) {}
0056
0057   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, error_code& __ec) : directory_iterator(__p, &__ec) {}
0058
0059   _LIBCPP_HIDE_FROM_ABI directory_iterator(const path& __p, directory_options __opts, error_code& __ec)
0060       : directory_iterator(__p, &__ec, __opts) {}
0061
0062   _LIBCPP_HIDE_FROM_ABI directory_iterator(const directory_iterator&)            = default;
0063   _LIBCPP_HIDE_FROM_ABI directory_iterator(directory_iterator&&)                 = default;
0064   _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(const directory_iterator&) = default;
0065
0066   _LIBCPP_HIDE_FROM_ABI directory_iterator& operator=(directory_iterator&& __o) noexcept {
0067     // non-default implementation provided to support self-move assign.
0068     if (this != &__o) {
0069       __imp_ = std::move(__o.__imp_);
0070     }
0071     return *this;
0072   }
0073
0074   _LIBCPP_HIDE_FROM_ABI ~directory_iterator() = default;
0075
0076   _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const {
0077     // Note: this check duplicates a check in `__dereference()`.
0078     _LIBCPP_ASSERT_NON_NULL(__imp_, "The end iterator cannot be dereferenced");
0079     return __dereference();
0080   }
0081
0082   _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &**this; }
0083
0084   _LIBCPP_HIDE_FROM_ABI directory_iterator& operator++() { return __increment(); }
0085
0086   _LIBCPP_HIDE_FROM_ABI __dir_element_proxy operator++(int) {
0087     __dir_element_proxy __p(**this);
0088     __increment();
0089     return __p;
0090   }
0091
0092   _LIBCPP_HIDE_FROM_ABI directory_iterator& increment(error_code& __ec) { return __increment(&__ec); }
0093
0094 #  if _LIBCPP_STD_VER >= 20
0095
0096   _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept { return *this == directory_iterator(); }
0097
0098 #  endif
0099
0100 private:
0101   inline _LIBCPP_HIDE_FROM_ABI friend bool
0102   operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept;
0103
0104   // construct the dir_stream
0105   _LIBCPP_EXPORTED_FROM_ABI directory_iterator(const path&, error_code*, directory_options = directory_options::none);
0106
0107   _LIBCPP_EXPORTED_FROM_ABI directory_iterator& __increment(error_code* __ec = nullptr);
0108
0109   _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const;
0110
0111 private:
0112   shared_ptr<__dir_stream> __imp_;
0113 };
0114
0115 inline _LIBCPP_HIDE_FROM_ABI bool
0116 operator==(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
0117   return __lhs.__imp_ == __rhs.__imp_;
0118 }
0119
0120 inline _LIBCPP_HIDE_FROM_ABI bool
0121 operator!=(const directory_iterator& __lhs, const directory_iterator& __rhs) noexcept {
0122   return !(__lhs == __rhs);
0123 }
0124
0125 // enable directory_iterator range-based for statements
0126 inline _LIBCPP_HIDE_FROM_ABI directory_iterator begin(directory_iterator __iter) noexcept { return __iter; }
0127
0128 inline _LIBCPP_HIDE_FROM_ABI directory_iterator end(directory_iterator) noexcept { return directory_iterator(); }
0129
0130 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
0131
0132 _LIBCPP_END_NAMESPACE_FILESYSTEM
0133
0134 #  if _LIBCPP_STD_VER >= 20
0135
0136 template <>
0137 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
0138     std::ranges::enable_borrowed_range<std::filesystem::directory_iterator> = true;
0139
0140 template <>
0141 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
0142     std::ranges::enable_view<std::filesystem::directory_iterator> = true;
0143
0144 #  endif // _LIBCPP_STD_VER >= 20
0145
0146 #endif // _LIBCPP_STD_VER >= 17 && _LIBCPP_HAS_FILESYSTEM
0147
0148 _LIBCPP_POP_MACROS
0149
0150 #endif // _LIBCPP___FILESYSTEM_DIRECTORY_ITERATOR_H