directory.hpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
  1. // boost/filesystem/directory.hpp ---------------------------------------------------//
  2. // Copyright Beman Dawes 2002-2009
  3. // Copyright Jan Langer 2002
  4. // Copyright Dietmar Kuehl 2001
  5. // Copyright Vladimir Prus 2002
  6. // Copyright Andrey Semashev 2019
  7. // Distributed under the Boost Software License, Version 1.0.
  8. // See http://www.boost.org/LICENSE_1_0.txt
  9. // Library home page: http://www.boost.org/libs/filesystem
  10. //--------------------------------------------------------------------------------------//
  11. #ifndef BOOST_FILESYSTEM_DIRECTORY_HPP
  12. #define BOOST_FILESYSTEM_DIRECTORY_HPP
  13. #include <boost/filesystem/config.hpp>
  14. #include <boost/filesystem/path.hpp>
  15. #include <boost/filesystem/file_status.hpp>
  16. #include <cstddef>
  17. #include <string>
  18. #include <vector>
  19. #include <utility> // std::move
  20. #include <boost/assert.hpp>
  21. #include <boost/core/scoped_enum.hpp>
  22. #include <boost/detail/bitmask.hpp>
  23. #include <boost/system/error_code.hpp>
  24. #include <boost/smart_ptr/intrusive_ptr.hpp>
  25. #include <boost/smart_ptr/intrusive_ref_counter.hpp>
  26. #include <boost/iterator/iterator_facade.hpp>
  27. #include <boost/iterator/iterator_categories.hpp>
  28. #include <boost/filesystem/detail/header.hpp> // must be the last #include
  29. //--------------------------------------------------------------------------------------//
  30. namespace boost {
  31. namespace filesystem {
  32. //--------------------------------------------------------------------------------------//
  33. // //
  34. // directory_entry //
  35. // //
  36. //--------------------------------------------------------------------------------------//
  37. // GCC has a problem with a member function named path within a namespace or
  38. // sub-namespace that also has a class named path. The workaround is to always
  39. // fully qualify the name path when it refers to the class name.
  40. class directory_entry
  41. {
  42. public:
  43. typedef boost::filesystem::path::value_type value_type; // enables class path ctor taking directory_entry
  44. directory_entry() BOOST_NOEXCEPT {}
  45. explicit directory_entry(boost::filesystem::path const& p) :
  46. m_path(p), m_status(file_status()), m_symlink_status(file_status())
  47. {
  48. }
  49. directory_entry(boost::filesystem::path const& p, file_status st, file_status symlink_st = file_status()) :
  50. m_path(p), m_status(st), m_symlink_status(symlink_st)
  51. {
  52. }
  53. directory_entry(directory_entry const& rhs) :
  54. m_path(rhs.m_path), m_status(rhs.m_status), m_symlink_status(rhs.m_symlink_status)
  55. {
  56. }
  57. directory_entry& operator=(directory_entry const& rhs)
  58. {
  59. m_path = rhs.m_path;
  60. m_status = rhs.m_status;
  61. m_symlink_status = rhs.m_symlink_status;
  62. return *this;
  63. }
  64. // As of October 2015 the interaction between noexcept and =default is so troublesome
  65. // for VC++, GCC, and probably other compilers, that =default is not used with noexcept
  66. // functions. GCC is not even consistent for the same release on different platforms.
  67. #if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
  68. directory_entry(directory_entry&& rhs) BOOST_NOEXCEPT :
  69. m_path(std::move(rhs.m_path)),
  70. m_status(std::move(rhs.m_status)),
  71. m_symlink_status(std::move(rhs.m_symlink_status))
  72. {
  73. }
  74. directory_entry& operator=(directory_entry&& rhs) BOOST_NOEXCEPT
  75. {
  76. m_path = std::move(rhs.m_path);
  77. m_status = std::move(rhs.m_status);
  78. m_symlink_status = std::move(rhs.m_symlink_status);
  79. return *this;
  80. }
  81. #endif
  82. void assign(boost::filesystem::path const& p, file_status st = file_status(), file_status symlink_st = file_status())
  83. {
  84. m_path = p;
  85. m_status = st;
  86. m_symlink_status = symlink_st;
  87. }
  88. void replace_filename(boost::filesystem::path const& p, file_status st = file_status(), file_status symlink_st = file_status())
  89. {
  90. m_path.remove_filename();
  91. m_path /= p;
  92. m_status = st;
  93. m_symlink_status = symlink_st;
  94. }
  95. #ifndef BOOST_FILESYSTEM_NO_DEPRECATED
  96. void replace_leaf(boost::filesystem::path const& p, file_status st, file_status symlink_st)
  97. {
  98. replace_filename(p, st, symlink_st);
  99. }
  100. #endif
  101. boost::filesystem::path const& path() const BOOST_NOEXCEPT
  102. {
  103. return m_path;
  104. }
  105. operator boost::filesystem::path const&() const BOOST_NOEXCEPT { return m_path; }
  106. file_status status() const { return get_status(); }
  107. file_status status(system::error_code& ec) const BOOST_NOEXCEPT { return get_status(&ec); }
  108. file_status symlink_status() const { return get_symlink_status(); }
  109. file_status symlink_status(system::error_code& ec) const BOOST_NOEXCEPT { return get_symlink_status(&ec); }
  110. bool operator==(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path == rhs.m_path; }
  111. bool operator!=(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path != rhs.m_path; }
  112. bool operator<(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path < rhs.m_path; }
  113. bool operator<=(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path <= rhs.m_path; }
  114. bool operator>(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path > rhs.m_path; }
  115. bool operator>=(directory_entry const& rhs) const BOOST_NOEXCEPT { return m_path >= rhs.m_path; }
  116. private:
  117. BOOST_FILESYSTEM_DECL file_status get_status(system::error_code* ec = 0) const;
  118. BOOST_FILESYSTEM_DECL file_status get_symlink_status(system::error_code* ec = 0) const;
  119. private:
  120. boost::filesystem::path m_path;
  121. mutable file_status m_status; // stat()-like
  122. mutable file_status m_symlink_status; // lstat()-like
  123. }; // directory_entry
  124. //--------------------------------------------------------------------------------------//
  125. // //
  126. // directory_entry overloads //
  127. // //
  128. //--------------------------------------------------------------------------------------//
  129. // Without these functions, calling (for example) 'is_directory' with a 'directory_entry' results in:
  130. // - a conversion to 'path' using 'operator boost::filesystem::path const&()',
  131. // - then a call to 'is_directory(path const& p)' which recomputes the status with 'detail::status(p)'.
  132. //
  133. // These functions avoid a costly recomputation of the status if one calls 'is_directory(e)' instead of 'is_directory(e.status())'
  134. inline file_status status(directory_entry const& e)
  135. {
  136. return e.status();
  137. }
  138. inline file_status status(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  139. {
  140. return e.status(ec);
  141. }
  142. inline bool type_present(directory_entry const& e)
  143. {
  144. return filesystem::type_present(e.status());
  145. }
  146. inline bool type_present(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  147. {
  148. return filesystem::type_present(e.status(ec));
  149. }
  150. inline bool status_known(directory_entry const& e)
  151. {
  152. return filesystem::status_known(e.status());
  153. }
  154. inline bool status_known(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  155. {
  156. return filesystem::status_known(e.status(ec));
  157. }
  158. inline bool exists(directory_entry const& e)
  159. {
  160. return filesystem::exists(e.status());
  161. }
  162. inline bool exists(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  163. {
  164. return filesystem::exists(e.status(ec));
  165. }
  166. inline bool is_regular_file(directory_entry const& e)
  167. {
  168. return filesystem::is_regular_file(e.status());
  169. }
  170. inline bool is_regular_file(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  171. {
  172. return filesystem::is_regular_file(e.status(ec));
  173. }
  174. inline bool is_directory(directory_entry const& e)
  175. {
  176. return filesystem::is_directory(e.status());
  177. }
  178. inline bool is_directory(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  179. {
  180. return filesystem::is_directory(e.status(ec));
  181. }
  182. inline bool is_symlink(directory_entry const& e)
  183. {
  184. return filesystem::is_symlink(e.symlink_status());
  185. }
  186. inline bool is_symlink(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  187. {
  188. return filesystem::is_symlink(e.symlink_status(ec));
  189. }
  190. inline bool is_other(directory_entry const& e)
  191. {
  192. return filesystem::is_other(e.status());
  193. }
  194. inline bool is_other(directory_entry const& e, system::error_code& ec) BOOST_NOEXCEPT
  195. {
  196. return filesystem::is_other(e.status(ec));
  197. }
  198. #ifndef BOOST_FILESYSTEM_NO_DEPRECATED
  199. inline bool is_regular(directory_entry const& e)
  200. {
  201. return filesystem::is_regular(e.status());
  202. }
  203. #endif
  204. //--------------------------------------------------------------------------------------//
  205. // //
  206. // directory_iterator helpers //
  207. // //
  208. //--------------------------------------------------------------------------------------//
  209. BOOST_SCOPED_ENUM_UT_DECLARE_BEGIN(directory_options, unsigned int)
  210. {
  211. none = 0u,
  212. skip_permission_denied = 1u, // if a directory cannot be opened because of insufficient permissions, pretend that the directory is empty
  213. follow_directory_symlink = 1u << 1, // recursive_directory_iterator: follow directory symlinks
  214. skip_dangling_symlinks = 1u << 2, // non-standard extension for recursive_directory_iterator: don't follow dangling directory symlinks,
  215. pop_on_error = 1u << 3, // non-standard extension for recursive_directory_iterator: instead of producing an end iterator on errors,
  216. // repeatedly invoke pop() until it succeeds or the iterator becomes equal to end iterator
  217. _detail_no_follow = 1u << 4, // internal use only
  218. _detail_no_push = 1u << 5 // internal use only
  219. }
  220. BOOST_SCOPED_ENUM_DECLARE_END(directory_options)
  221. BOOST_BITMASK(BOOST_SCOPED_ENUM_NATIVE(directory_options))
  222. class directory_iterator;
  223. namespace detail {
  224. struct dir_itr_imp :
  225. public boost::intrusive_ref_counter< dir_itr_imp >
  226. {
  227. #ifdef BOOST_WINDOWS_API
  228. unsigned char extra_data_format;
  229. std::size_t current_offset;
  230. #endif
  231. directory_entry dir_entry;
  232. void* handle;
  233. dir_itr_imp() BOOST_NOEXCEPT :
  234. #ifdef BOOST_WINDOWS_API
  235. extra_data_format(0u),
  236. current_offset(0u),
  237. #endif
  238. handle(NULL)
  239. {
  240. }
  241. BOOST_FILESYSTEM_DECL ~dir_itr_imp() BOOST_NOEXCEPT;
  242. BOOST_FILESYSTEM_DECL static void* operator new(std::size_t class_size, std::size_t extra_size) BOOST_NOEXCEPT;
  243. BOOST_FILESYSTEM_DECL static void operator delete(void* p, std::size_t extra_size) BOOST_NOEXCEPT;
  244. BOOST_FILESYSTEM_DECL static void operator delete(void* p) BOOST_NOEXCEPT;
  245. };
  246. BOOST_FILESYSTEM_DECL void directory_iterator_construct(directory_iterator& it, path const& p, unsigned int opts, system::error_code* ec);
  247. BOOST_FILESYSTEM_DECL void directory_iterator_increment(directory_iterator& it, system::error_code* ec);
  248. } // namespace detail
  249. //--------------------------------------------------------------------------------------//
  250. // //
  251. // directory_iterator //
  252. // //
  253. //--------------------------------------------------------------------------------------//
  254. class directory_iterator :
  255. public boost::iterator_facade<
  256. directory_iterator,
  257. directory_entry,
  258. boost::single_pass_traversal_tag
  259. >
  260. {
  261. friend class boost::iterator_core_access;
  262. friend BOOST_FILESYSTEM_DECL void detail::directory_iterator_construct(directory_iterator& it, path const& p, unsigned int opts, system::error_code* ec);
  263. friend BOOST_FILESYSTEM_DECL void detail::directory_iterator_increment(directory_iterator& it, system::error_code* ec);
  264. public:
  265. directory_iterator() BOOST_NOEXCEPT {} // creates the "end" iterator
  266. // iterator_facade derived classes don't seem to like implementations in
  267. // separate translation unit dll's, so forward to detail functions
  268. explicit directory_iterator(path const& p, BOOST_SCOPED_ENUM_NATIVE(directory_options) opts = directory_options::none)
  269. {
  270. detail::directory_iterator_construct(*this, p, static_cast< unsigned int >(opts), 0);
  271. }
  272. directory_iterator(path const& p, system::error_code& ec) BOOST_NOEXCEPT
  273. {
  274. detail::directory_iterator_construct(*this, p, static_cast< unsigned int >(directory_options::none), &ec);
  275. }
  276. directory_iterator(path const& p, BOOST_SCOPED_ENUM_NATIVE(directory_options) opts, system::error_code& ec) BOOST_NOEXCEPT
  277. {
  278. detail::directory_iterator_construct(*this, p, static_cast< unsigned int >(opts), &ec);
  279. }
  280. BOOST_DEFAULTED_FUNCTION(directory_iterator(directory_iterator const& that), : m_imp(that.m_imp) {})
  281. BOOST_DEFAULTED_FUNCTION(directory_iterator& operator=(directory_iterator const& that), { m_imp = that.m_imp; return *this; })
  282. #if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
  283. directory_iterator(directory_iterator&& that) BOOST_NOEXCEPT :
  284. m_imp(std::move(that.m_imp))
  285. {
  286. }
  287. directory_iterator& operator=(directory_iterator&& that) BOOST_NOEXCEPT
  288. {
  289. m_imp = std::move(that.m_imp);
  290. return *this;
  291. }
  292. #endif // !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
  293. directory_iterator& increment(system::error_code& ec) BOOST_NOEXCEPT
  294. {
  295. detail::directory_iterator_increment(*this, &ec);
  296. return *this;
  297. }
  298. private:
  299. boost::iterator_facade<
  300. directory_iterator,
  301. directory_entry,
  302. boost::single_pass_traversal_tag
  303. >::reference dereference() const
  304. {
  305. BOOST_ASSERT_MSG(!is_end(), "attempt to dereference end directory iterator");
  306. return m_imp->dir_entry;
  307. }
  308. void increment() { detail::directory_iterator_increment(*this, 0); }
  309. bool equal(directory_iterator const& rhs) const BOOST_NOEXCEPT
  310. {
  311. return m_imp == rhs.m_imp || (is_end() && rhs.is_end());
  312. }
  313. bool is_end() const BOOST_NOEXCEPT
  314. {
  315. // Note: The check for handle is needed because the iterator can be copied and the copy
  316. // can be incremented to end while the original iterator still refers to the same dir_itr_imp.
  317. return !m_imp || !m_imp->handle;
  318. }
  319. private:
  320. // intrusive_ptr provides the shallow-copy semantics required for single pass iterators
  321. // (i.e. InputIterators). The end iterator is indicated by is_end().
  322. boost::intrusive_ptr< detail::dir_itr_imp > m_imp;
  323. };
  324. // enable directory_iterator C++11 range-based for statement use --------------------//
  325. // begin() and end() are only used by a range-based for statement in the context of
  326. // auto - thus the top-level const is stripped - so returning const is harmless and
  327. // emphasizes begin() is just a pass through.
  328. inline directory_iterator const& begin(directory_iterator const& iter) BOOST_NOEXCEPT
  329. {
  330. return iter;
  331. }
  332. inline directory_iterator end(directory_iterator const&) BOOST_NOEXCEPT
  333. {
  334. return directory_iterator();
  335. }
  336. // enable C++14 generic accessors for range const iterators
  337. inline directory_iterator const& cbegin(directory_iterator const& iter) BOOST_NOEXCEPT
  338. {
  339. return iter;
  340. }
  341. inline directory_iterator cend(directory_iterator const&) BOOST_NOEXCEPT
  342. {
  343. return directory_iterator();
  344. }
  345. // enable directory_iterator BOOST_FOREACH -----------------------------------------//
  346. inline directory_iterator& range_begin(directory_iterator& iter) BOOST_NOEXCEPT
  347. {
  348. return iter;
  349. }
  350. inline directory_iterator range_begin(directory_iterator const& iter) BOOST_NOEXCEPT
  351. {
  352. return iter;
  353. }
  354. inline directory_iterator range_end(directory_iterator&) BOOST_NOEXCEPT
  355. {
  356. return directory_iterator();
  357. }
  358. inline directory_iterator range_end(directory_iterator const&) BOOST_NOEXCEPT
  359. {
  360. return directory_iterator();
  361. }
  362. } // namespace filesystem
  363. // namespace boost template specializations
  364. template< typename C, typename Enabler >
  365. struct range_mutable_iterator;
  366. template<>
  367. struct range_mutable_iterator< boost::filesystem::directory_iterator, void >
  368. {
  369. typedef boost::filesystem::directory_iterator type;
  370. };
  371. template< typename C, typename Enabler >
  372. struct range_const_iterator;
  373. template<>
  374. struct range_const_iterator< boost::filesystem::directory_iterator, void >
  375. {
  376. typedef boost::filesystem::directory_iterator type;
  377. };
  378. namespace filesystem {
  379. //--------------------------------------------------------------------------------------//
  380. // //
  381. // recursive_directory_iterator helpers //
  382. // //
  383. //--------------------------------------------------------------------------------------//
  384. #if !defined(BOOST_FILESYSTEM_NO_DEPRECATED)
  385. // Deprecated enum, use directory_options instead
  386. BOOST_SCOPED_ENUM_UT_DECLARE_BEGIN(symlink_option, unsigned int)
  387. {
  388. none = static_cast< unsigned int >(directory_options::none),
  389. no_recurse = none, // don't follow directory symlinks (default behavior)
  390. recurse = static_cast< unsigned int >(directory_options::follow_directory_symlink), // follow directory symlinks
  391. _detail_no_push = static_cast< unsigned int >(directory_options::_detail_no_push) // internal use only
  392. }
  393. BOOST_SCOPED_ENUM_DECLARE_END(symlink_option)
  394. BOOST_BITMASK(BOOST_SCOPED_ENUM_NATIVE(symlink_option))
  395. #endif // BOOST_FILESYSTEM_NO_DEPRECATED
  396. class recursive_directory_iterator;
  397. namespace detail {
  398. struct recur_dir_itr_imp :
  399. public boost::intrusive_ref_counter< recur_dir_itr_imp >
  400. {
  401. typedef directory_iterator element_type;
  402. std::vector< element_type > m_stack;
  403. // directory_options values, declared as unsigned int for ABI compatibility
  404. unsigned int m_options;
  405. explicit recur_dir_itr_imp(unsigned int opts) BOOST_NOEXCEPT : m_options(opts) {}
  406. };
  407. BOOST_FILESYSTEM_DECL void recursive_directory_iterator_construct(recursive_directory_iterator& it, path const& dir_path, unsigned int opts, system::error_code* ec);
  408. BOOST_FILESYSTEM_DECL void recursive_directory_iterator_increment(recursive_directory_iterator& it, system::error_code* ec);
  409. BOOST_FILESYSTEM_DECL void recursive_directory_iterator_pop(recursive_directory_iterator& it, system::error_code* ec);
  410. } // namespace detail
  411. //--------------------------------------------------------------------------------------//
  412. // //
  413. // recursive_directory_iterator //
  414. // //
  415. //--------------------------------------------------------------------------------------//
  416. class recursive_directory_iterator :
  417. public boost::iterator_facade<
  418. recursive_directory_iterator,
  419. directory_entry,
  420. boost::single_pass_traversal_tag
  421. >
  422. {
  423. friend class boost::iterator_core_access;
  424. friend BOOST_FILESYSTEM_DECL void detail::recursive_directory_iterator_construct(recursive_directory_iterator& it, path const& dir_path, unsigned int opts, system::error_code* ec);
  425. friend BOOST_FILESYSTEM_DECL void detail::recursive_directory_iterator_increment(recursive_directory_iterator& it, system::error_code* ec);
  426. friend BOOST_FILESYSTEM_DECL void detail::recursive_directory_iterator_pop(recursive_directory_iterator& it, system::error_code* ec);
  427. public:
  428. recursive_directory_iterator() BOOST_NOEXCEPT {} // creates the "end" iterator
  429. explicit recursive_directory_iterator(path const& dir_path)
  430. {
  431. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(directory_options::none), 0);
  432. }
  433. recursive_directory_iterator(path const& dir_path, system::error_code& ec)
  434. {
  435. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(directory_options::none), &ec);
  436. }
  437. recursive_directory_iterator(path const& dir_path, BOOST_SCOPED_ENUM_NATIVE(directory_options) opts)
  438. {
  439. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(opts), 0);
  440. }
  441. recursive_directory_iterator(path const& dir_path, BOOST_SCOPED_ENUM_NATIVE(directory_options) opts, system::error_code& ec)
  442. {
  443. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(opts), &ec);
  444. }
  445. #if !defined(BOOST_FILESYSTEM_NO_DEPRECATED)
  446. // Deprecated constructors
  447. recursive_directory_iterator(path const& dir_path, BOOST_SCOPED_ENUM_NATIVE(symlink_option) opts)
  448. {
  449. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(opts), 0);
  450. }
  451. recursive_directory_iterator(path const& dir_path, BOOST_SCOPED_ENUM_NATIVE(symlink_option) opts, system::error_code& ec) BOOST_NOEXCEPT
  452. {
  453. detail::recursive_directory_iterator_construct(*this, dir_path, static_cast< unsigned int >(opts), &ec);
  454. }
  455. #endif // BOOST_FILESYSTEM_NO_DEPRECATED
  456. BOOST_DEFAULTED_FUNCTION(recursive_directory_iterator(recursive_directory_iterator const& that), : m_imp(that.m_imp) {})
  457. BOOST_DEFAULTED_FUNCTION(recursive_directory_iterator& operator=(recursive_directory_iterator const& that), { m_imp = that.m_imp; return *this; })
  458. #if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
  459. recursive_directory_iterator(recursive_directory_iterator&& that) BOOST_NOEXCEPT :
  460. m_imp(std::move(that.m_imp))
  461. {
  462. }
  463. recursive_directory_iterator& operator=(recursive_directory_iterator&& that) BOOST_NOEXCEPT
  464. {
  465. m_imp = std::move(that.m_imp);
  466. return *this;
  467. }
  468. #endif // !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
  469. recursive_directory_iterator& increment(system::error_code& ec) BOOST_NOEXCEPT
  470. {
  471. detail::recursive_directory_iterator_increment(*this, &ec);
  472. return *this;
  473. }
  474. int depth() const BOOST_NOEXCEPT
  475. {
  476. BOOST_ASSERT_MSG(!is_end(), "depth() on end recursive_directory_iterator");
  477. return static_cast< int >(m_imp->m_stack.size() - 1u);
  478. }
  479. bool recursion_pending() const BOOST_NOEXCEPT
  480. {
  481. BOOST_ASSERT_MSG(!is_end(), "recursion_pending() on end recursive_directory_iterator");
  482. return (m_imp->m_options & static_cast< unsigned int >(directory_options::_detail_no_push)) == 0u;
  483. }
  484. #ifndef BOOST_FILESYSTEM_NO_DEPRECATED
  485. int level() const BOOST_NOEXCEPT
  486. {
  487. return depth();
  488. }
  489. bool no_push_pending() const BOOST_NOEXCEPT { return !recursion_pending(); }
  490. bool no_push_request() const BOOST_NOEXCEPT { return !recursion_pending(); }
  491. #endif
  492. void pop()
  493. {
  494. detail::recursive_directory_iterator_pop(*this, 0);
  495. }
  496. void pop(system::error_code& ec) BOOST_NOEXCEPT
  497. {
  498. detail::recursive_directory_iterator_pop(*this, &ec);
  499. }
  500. void disable_recursion_pending(bool value = true) BOOST_NOEXCEPT
  501. {
  502. BOOST_ASSERT_MSG(!is_end(), "disable_recursion_pending() on end recursive_directory_iterator");
  503. if (value)
  504. m_imp->m_options |= static_cast< unsigned int >(directory_options::_detail_no_push);
  505. else
  506. m_imp->m_options &= ~static_cast< unsigned int >(directory_options::_detail_no_push);
  507. }
  508. #ifndef BOOST_FILESYSTEM_NO_DEPRECATED
  509. void no_push(bool value = true) BOOST_NOEXCEPT
  510. {
  511. disable_recursion_pending(value);
  512. }
  513. #endif
  514. file_status status() const
  515. {
  516. BOOST_ASSERT_MSG(!is_end(), "status() on end recursive_directory_iterator");
  517. return m_imp->m_stack.back()->status();
  518. }
  519. file_status symlink_status() const
  520. {
  521. BOOST_ASSERT_MSG(!is_end(), "symlink_status() on end recursive_directory_iterator");
  522. return m_imp->m_stack.back()->symlink_status();
  523. }
  524. private:
  525. boost::iterator_facade<
  526. recursive_directory_iterator,
  527. directory_entry,
  528. boost::single_pass_traversal_tag
  529. >::reference dereference() const
  530. {
  531. BOOST_ASSERT_MSG(!is_end(), "dereference of end recursive_directory_iterator");
  532. return *m_imp->m_stack.back();
  533. }
  534. void increment() { detail::recursive_directory_iterator_increment(*this, 0); }
  535. bool equal(recursive_directory_iterator const& rhs) const BOOST_NOEXCEPT
  536. {
  537. return m_imp == rhs.m_imp || (is_end() && rhs.is_end());
  538. }
  539. bool is_end() const BOOST_NOEXCEPT
  540. {
  541. // Note: The check for m_stack.empty() is needed because the iterator can be copied and the copy
  542. // can be incremented to end while the original iterator still refers to the same recur_dir_itr_imp.
  543. return !m_imp || m_imp->m_stack.empty();
  544. }
  545. private:
  546. // intrusive_ptr provides the shallow-copy semantics required for single pass iterators
  547. // (i.e. InputIterators). The end iterator is indicated by is_end().
  548. boost::intrusive_ptr< detail::recur_dir_itr_imp > m_imp;
  549. };
  550. #if !defined(BOOST_FILESYSTEM_NO_DEPRECATED)
  551. typedef recursive_directory_iterator wrecursive_directory_iterator;
  552. #endif
  553. // enable recursive directory iterator C++11 range-base for statement use ----------//
  554. // begin() and end() are only used by a range-based for statement in the context of
  555. // auto - thus the top-level const is stripped - so returning const is harmless and
  556. // emphasizes begin() is just a pass through.
  557. inline recursive_directory_iterator const& begin(recursive_directory_iterator const& iter) BOOST_NOEXCEPT
  558. {
  559. return iter;
  560. }
  561. inline recursive_directory_iterator end(recursive_directory_iterator const&) BOOST_NOEXCEPT
  562. {
  563. return recursive_directory_iterator();
  564. }
  565. // enable C++14 generic accessors for range const iterators
  566. inline recursive_directory_iterator const& cbegin(recursive_directory_iterator const& iter) BOOST_NOEXCEPT
  567. {
  568. return iter;
  569. }
  570. inline recursive_directory_iterator cend(recursive_directory_iterator const&) BOOST_NOEXCEPT
  571. {
  572. return recursive_directory_iterator();
  573. }
  574. // enable recursive directory iterator BOOST_FOREACH -------------------------------//
  575. inline recursive_directory_iterator& range_begin(recursive_directory_iterator& iter) BOOST_NOEXCEPT
  576. {
  577. return iter;
  578. }
  579. inline recursive_directory_iterator range_begin(recursive_directory_iterator const& iter) BOOST_NOEXCEPT
  580. {
  581. return iter;
  582. }
  583. inline recursive_directory_iterator range_end(recursive_directory_iterator&) BOOST_NOEXCEPT
  584. {
  585. return recursive_directory_iterator();
  586. }
  587. inline recursive_directory_iterator range_end(recursive_directory_iterator const&) BOOST_NOEXCEPT
  588. {
  589. return recursive_directory_iterator();
  590. }
  591. } // namespace filesystem
  592. // namespace boost template specializations
  593. template<>
  594. struct range_mutable_iterator< boost::filesystem::recursive_directory_iterator, void >
  595. {
  596. typedef boost::filesystem::recursive_directory_iterator type;
  597. };
  598. template<>
  599. struct range_const_iterator< boost::filesystem::recursive_directory_iterator, void >
  600. {
  601. typedef boost::filesystem::recursive_directory_iterator type;
  602. };
  603. } // namespace boost
  604. #include <boost/filesystem/detail/footer.hpp>
  605. #endif // BOOST_FILESYSTEM_DIRECTORY_HPP