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