__cxx03/__filesystem/recursive_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_RECURSIVE_DIRECTORY_ITERATOR_H
0011 #define _LIBCPP___CXX03___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H
0012
0013 #include <__cxx03/__config>
0014 #include <__cxx03/__filesystem/directory_entry.h>
0015 #include <__cxx03/__filesystem/directory_options.h>
0016 #include <__cxx03/__filesystem/path.h>
0017 #include <__cxx03/__iterator/default_sentinel.h>
0018 #include <__cxx03/__iterator/iterator_traits.h>
0019 #include <__cxx03/__memory/shared_ptr.h>
0020 #include <__cxx03/__ranges/enable_borrowed_range.h>
0021 #include <__cxx03/__ranges/enable_view.h>
0022 #include <__cxx03/__system_error/error_code.h>
0023 #include <__cxx03/__utility/move.h>
0024 #include <__cxx03/cstddef>
0025
0026 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
0027 #  pragma GCC system_header
0028 #endif
0029
0030 _LIBCPP_PUSH_MACROS
0031 #include <__cxx03/__undef_macros>
0032
0033 #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
0034
0035 _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
0036
0037 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH
0038
0039 class recursive_directory_iterator {
0040 public:
0041   using value_type        = directory_entry;
0042   using difference_type   = ptrdiff_t;
0043   using pointer           = directory_entry const*;
0044   using reference         = directory_entry const&;
0045   using iterator_category = input_iterator_tag;
0046
0047 public:
0048   // constructors and destructor
0049   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator() noexcept : __rec_(false) {}
0050
0051   _LIBCPP_HIDE_FROM_ABI explicit recursive_directory_iterator(
0052       const path& __p, directory_options __xoptions = directory_options::none)
0053       : recursive_directory_iterator(__p, __xoptions, nullptr) {}
0054
0055   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __xoptions, error_code& __ec)
0056       : recursive_directory_iterator(__p, __xoptions, &__ec) {}
0057
0058   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const path& __p, error_code& __ec)
0059       : recursive_directory_iterator(__p, directory_options::none, &__ec) {}
0060
0061   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(const recursive_directory_iterator&) = default;
0062   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator(recursive_directory_iterator&&)      = default;
0063
0064   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(const recursive_directory_iterator&) = default;
0065
0066   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator=(recursive_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       __rec_ = __o.__rec_;
0071     }
0072     return *this;
0073   }
0074
0075   _LIBCPP_HIDE_FROM_ABI ~recursive_directory_iterator() = default;
0076
0077   _LIBCPP_HIDE_FROM_ABI const directory_entry& operator*() const { return __dereference(); }
0078
0079   _LIBCPP_HIDE_FROM_ABI const directory_entry* operator->() const { return &__dereference(); }
0080
0081   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& operator++() { return __increment(); }
0082
0083   _LIBCPP_HIDE_FROM_ABI __dir_element_proxy operator++(int) {
0084     __dir_element_proxy __p(**this);
0085     __increment();
0086     return __p;
0087   }
0088
0089   _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator& increment(error_code& __ec) { return __increment(&__ec); }
0090
0091   _LIBCPP_EXPORTED_FROM_ABI directory_options options() const;
0092   _LIBCPP_EXPORTED_FROM_ABI int depth() const;
0093
0094   _LIBCPP_HIDE_FROM_ABI void pop() { __pop(); }
0095
0096   _LIBCPP_HIDE_FROM_ABI void pop(error_code& __ec) { __pop(&__ec); }
0097
0098   _LIBCPP_HIDE_FROM_ABI bool recursion_pending() const { return __rec_; }
0099
0100   _LIBCPP_HIDE_FROM_ABI void disable_recursion_pending() { __rec_ = false; }
0101
0102 #  if _LIBCPP_STD_VER >= 20
0103
0104   _LIBCPP_HIDE_FROM_ABI bool operator==(default_sentinel_t) const noexcept {
0105     return *this == recursive_directory_iterator();
0106   }
0107
0108 #  endif
0109
0110 private:
0111   _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator(const path& __p, directory_options __opt, error_code* __ec);
0112   _LIBCPP_EXPORTED_FROM_ABI const directory_entry& __dereference() const;
0113   _LIBCPP_EXPORTED_FROM_ABI bool __try_recursion(error_code* __ec);
0114   _LIBCPP_EXPORTED_FROM_ABI void __advance(error_code* __ec = nullptr);
0115   _LIBCPP_EXPORTED_FROM_ABI recursive_directory_iterator& __increment(error_code* __ec = nullptr);
0116   _LIBCPP_EXPORTED_FROM_ABI void __pop(error_code* __ec = nullptr);
0117
0118   inline _LIBCPP_HIDE_FROM_ABI friend bool
0119   operator==(const recursive_directory_iterator&, const recursive_directory_iterator&) noexcept;
0120
0121   struct _LIBCPP_HIDDEN __shared_imp;
0122   shared_ptr<__shared_imp> __imp_;
0123   bool __rec_;
0124 }; // class recursive_directory_iterator
0125
0126 inline _LIBCPP_HIDE_FROM_ABI bool
0127 operator==(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept {
0128   return __lhs.__imp_ == __rhs.__imp_;
0129 }
0130
0131 _LIBCPP_HIDE_FROM_ABI inline bool
0132 operator!=(const recursive_directory_iterator& __lhs, const recursive_directory_iterator& __rhs) noexcept {
0133   return !(__lhs == __rhs);
0134 }
0135 // enable recursive_directory_iterator range-based for statements
0136 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator begin(recursive_directory_iterator __iter) noexcept {
0137   return __iter;
0138 }
0139
0140 inline _LIBCPP_HIDE_FROM_ABI recursive_directory_iterator end(recursive_directory_iterator) noexcept {
0141   return recursive_directory_iterator();
0142 }
0143
0144 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
0145
0146 _LIBCPP_END_NAMESPACE_FILESYSTEM
0147
0148 #  if _LIBCPP_STD_VER >= 20
0149
0150 template <>
0151 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
0152     std::ranges::enable_borrowed_range<std::filesystem::recursive_directory_iterator> = true;
0153
0154 template <>
0155 _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY inline constexpr bool
0156     std::ranges::enable_view<std::filesystem::recursive_directory_iterator> = true;
0157
0158 #  endif // _LIBCPP_STD_VER >= 20
0159
0160 #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
0161
0162 _LIBCPP_POP_MACROS
0163
0164 #endif // _LIBCPP___CXX03___FILESYSTEM_RECURSIVE_DIRECTORY_ITERATOR_H