directory_entry.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  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. #ifndef _LIBCPP___FILESYSTEM_DIRECTORY_ENTRY_H
  10. #define _LIBCPP___FILESYSTEM_DIRECTORY_ENTRY_H
  11. #include <__availability>
  12. #include <__chrono/time_point.h>
  13. #include <__compare/ordering.h>
  14. #include <__config>
  15. #include <__filesystem/file_status.h>
  16. #include <__filesystem/file_time_type.h>
  17. #include <__filesystem/file_type.h>
  18. #include <__filesystem/filesystem_error.h>
  19. #include <__filesystem/operations.h>
  20. #include <__filesystem/path.h>
  21. #include <__filesystem/perms.h>
  22. #include <__system_error/errc.h>
  23. #include <__system_error/error_code.h>
  24. #include <__utility/move.h>
  25. #include <__utility/unreachable.h>
  26. #include <cstdint>
  27. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  28. # pragma GCC system_header
  29. #endif
  30. _LIBCPP_PUSH_MACROS
  31. #include <__undef_macros>
  32. #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
  33. _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
  34. _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH
  35. class directory_entry {
  36. typedef filesystem::path _Path;
  37. public:
  38. // constructors and destructors
  39. _LIBCPP_HIDE_FROM_ABI directory_entry() noexcept = default;
  40. _LIBCPP_HIDE_FROM_ABI directory_entry(directory_entry const&) = default;
  41. _LIBCPP_HIDE_FROM_ABI directory_entry(directory_entry&&) noexcept = default;
  42. _LIBCPP_HIDE_FROM_ABI explicit directory_entry(_Path const& __p) : __p_(__p) {
  43. error_code __ec;
  44. __refresh(&__ec);
  45. }
  46. _LIBCPP_HIDE_FROM_ABI directory_entry(_Path const& __p, error_code& __ec) : __p_(__p) { __refresh(&__ec); }
  47. _LIBCPP_HIDE_FROM_ABI ~directory_entry() {}
  48. _LIBCPP_HIDE_FROM_ABI directory_entry& operator=(directory_entry const&) = default;
  49. _LIBCPP_HIDE_FROM_ABI directory_entry& operator=(directory_entry&&) noexcept = default;
  50. _LIBCPP_HIDE_FROM_ABI void assign(_Path const& __p) {
  51. __p_ = __p;
  52. error_code __ec;
  53. __refresh(&__ec);
  54. }
  55. _LIBCPP_HIDE_FROM_ABI void assign(_Path const& __p, error_code& __ec) {
  56. __p_ = __p;
  57. __refresh(&__ec);
  58. }
  59. _LIBCPP_HIDE_FROM_ABI void replace_filename(_Path const& __p) {
  60. __p_.replace_filename(__p);
  61. error_code __ec;
  62. __refresh(&__ec);
  63. }
  64. _LIBCPP_HIDE_FROM_ABI void replace_filename(_Path const& __p, error_code& __ec) {
  65. __p_ = __p_.parent_path() / __p;
  66. __refresh(&__ec);
  67. }
  68. _LIBCPP_HIDE_FROM_ABI void refresh() { __refresh(); }
  69. _LIBCPP_HIDE_FROM_ABI void refresh(error_code& __ec) noexcept { __refresh(&__ec); }
  70. _LIBCPP_HIDE_FROM_ABI _Path const& path() const noexcept { return __p_; }
  71. _LIBCPP_HIDE_FROM_ABI operator const _Path&() const noexcept { return __p_; }
  72. _LIBCPP_HIDE_FROM_ABI bool exists() const { return filesystem::exists(file_status{__get_ft()}); }
  73. _LIBCPP_HIDE_FROM_ABI bool exists(error_code& __ec) const noexcept {
  74. return filesystem::exists(file_status{__get_ft(&__ec)});
  75. }
  76. _LIBCPP_HIDE_FROM_ABI bool is_block_file() const { return __get_ft() == file_type::block; }
  77. _LIBCPP_HIDE_FROM_ABI bool is_block_file(error_code& __ec) const noexcept {
  78. return __get_ft(&__ec) == file_type::block;
  79. }
  80. _LIBCPP_HIDE_FROM_ABI bool is_character_file() const { return __get_ft() == file_type::character; }
  81. _LIBCPP_HIDE_FROM_ABI bool is_character_file(error_code& __ec) const noexcept {
  82. return __get_ft(&__ec) == file_type::character;
  83. }
  84. _LIBCPP_HIDE_FROM_ABI bool is_directory() const { return __get_ft() == file_type::directory; }
  85. _LIBCPP_HIDE_FROM_ABI bool is_directory(error_code& __ec) const noexcept {
  86. return __get_ft(&__ec) == file_type::directory;
  87. }
  88. _LIBCPP_HIDE_FROM_ABI bool is_fifo() const { return __get_ft() == file_type::fifo; }
  89. _LIBCPP_HIDE_FROM_ABI bool is_fifo(error_code& __ec) const noexcept { return __get_ft(&__ec) == file_type::fifo; }
  90. _LIBCPP_HIDE_FROM_ABI bool is_other() const { return filesystem::is_other(file_status{__get_ft()}); }
  91. _LIBCPP_HIDE_FROM_ABI bool is_other(error_code& __ec) const noexcept {
  92. return filesystem::is_other(file_status{__get_ft(&__ec)});
  93. }
  94. _LIBCPP_HIDE_FROM_ABI bool is_regular_file() const { return __get_ft() == file_type::regular; }
  95. _LIBCPP_HIDE_FROM_ABI bool is_regular_file(error_code& __ec) const noexcept {
  96. return __get_ft(&__ec) == file_type::regular;
  97. }
  98. _LIBCPP_HIDE_FROM_ABI bool is_socket() const { return __get_ft() == file_type::socket; }
  99. _LIBCPP_HIDE_FROM_ABI bool is_socket(error_code& __ec) const noexcept { return __get_ft(&__ec) == file_type::socket; }
  100. _LIBCPP_HIDE_FROM_ABI bool is_symlink() const { return __get_sym_ft() == file_type::symlink; }
  101. _LIBCPP_HIDE_FROM_ABI bool is_symlink(error_code& __ec) const noexcept {
  102. return __get_sym_ft(&__ec) == file_type::symlink;
  103. }
  104. _LIBCPP_HIDE_FROM_ABI uintmax_t file_size() const { return __get_size(); }
  105. _LIBCPP_HIDE_FROM_ABI uintmax_t file_size(error_code& __ec) const noexcept { return __get_size(&__ec); }
  106. _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count() const { return __get_nlink(); }
  107. _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count(error_code& __ec) const noexcept { return __get_nlink(&__ec); }
  108. _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time() const { return __get_write_time(); }
  109. _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time(error_code& __ec) const noexcept {
  110. return __get_write_time(&__ec);
  111. }
  112. _LIBCPP_HIDE_FROM_ABI file_status status() const { return __get_status(); }
  113. _LIBCPP_HIDE_FROM_ABI file_status status(error_code& __ec) const noexcept { return __get_status(&__ec); }
  114. _LIBCPP_HIDE_FROM_ABI file_status symlink_status() const { return __get_symlink_status(); }
  115. _LIBCPP_HIDE_FROM_ABI file_status symlink_status(error_code& __ec) const noexcept {
  116. return __get_symlink_status(&__ec);
  117. }
  118. _LIBCPP_HIDE_FROM_ABI bool operator==(directory_entry const& __rhs) const noexcept { return __p_ == __rhs.__p_; }
  119. # if _LIBCPP_STD_VER <= 17
  120. _LIBCPP_HIDE_FROM_ABI bool operator!=(directory_entry const& __rhs) const noexcept { return __p_ != __rhs.__p_; }
  121. _LIBCPP_HIDE_FROM_ABI bool operator<(directory_entry const& __rhs) const noexcept { return __p_ < __rhs.__p_; }
  122. _LIBCPP_HIDE_FROM_ABI bool operator<=(directory_entry const& __rhs) const noexcept { return __p_ <= __rhs.__p_; }
  123. _LIBCPP_HIDE_FROM_ABI bool operator>(directory_entry const& __rhs) const noexcept { return __p_ > __rhs.__p_; }
  124. _LIBCPP_HIDE_FROM_ABI bool operator>=(directory_entry const& __rhs) const noexcept { return __p_ >= __rhs.__p_; }
  125. # else // _LIBCPP_STD_VER <= 17
  126. _LIBCPP_HIDE_FROM_ABI strong_ordering operator<=>(const directory_entry& __rhs) const noexcept {
  127. return __p_ <=> __rhs.__p_;
  128. }
  129. # endif // _LIBCPP_STD_VER <= 17
  130. template <class _CharT, class _Traits>
  131. _LIBCPP_HIDE_FROM_ABI friend basic_ostream<_CharT, _Traits>&
  132. operator<<(basic_ostream<_CharT, _Traits>& __os, const directory_entry& __d) {
  133. return __os << __d.path();
  134. }
  135. private:
  136. friend class directory_iterator;
  137. friend class recursive_directory_iterator;
  138. friend class _LIBCPP_HIDDEN __dir_stream;
  139. enum _CacheType : unsigned char {
  140. _Empty,
  141. _IterSymlink,
  142. _IterNonSymlink,
  143. _RefreshSymlink,
  144. _RefreshSymlinkUnresolved,
  145. _RefreshNonSymlink,
  146. _IterCachedSymlink,
  147. _IterCachedNonSymlink
  148. };
  149. struct __cached_data {
  150. uintmax_t __size_;
  151. uintmax_t __nlink_;
  152. file_time_type __write_time_;
  153. perms __sym_perms_;
  154. perms __non_sym_perms_;
  155. file_type __type_;
  156. _CacheType __cache_type_;
  157. _LIBCPP_HIDE_FROM_ABI __cached_data() noexcept { __reset(); }
  158. _LIBCPP_HIDE_FROM_ABI void __reset() {
  159. __cache_type_ = _Empty;
  160. __type_ = file_type::none;
  161. __sym_perms_ = __non_sym_perms_ = perms::unknown;
  162. __size_ = __nlink_ = uintmax_t(-1);
  163. __write_time_ = file_time_type::min();
  164. }
  165. };
  166. _LIBCPP_HIDE_FROM_ABI static __cached_data __create_iter_result(file_type __ft) {
  167. __cached_data __data;
  168. __data.__type_ = __ft;
  169. __data.__cache_type_ = [&]() {
  170. switch (__ft) {
  171. case file_type::none:
  172. return _Empty;
  173. case file_type::symlink:
  174. return _IterSymlink;
  175. default:
  176. return _IterNonSymlink;
  177. }
  178. }();
  179. return __data;
  180. }
  181. _LIBCPP_HIDE_FROM_ABI static __cached_data
  182. __create_iter_cached_result(file_type __ft, uintmax_t __size, perms __perm, file_time_type __write_time) {
  183. __cached_data __data;
  184. __data.__type_ = __ft;
  185. __data.__size_ = __size;
  186. __data.__write_time_ = __write_time;
  187. if (__ft == file_type::symlink)
  188. __data.__sym_perms_ = __perm;
  189. else
  190. __data.__non_sym_perms_ = __perm;
  191. __data.__cache_type_ = [&]() {
  192. switch (__ft) {
  193. case file_type::none:
  194. return _Empty;
  195. case file_type::symlink:
  196. return _IterCachedSymlink;
  197. default:
  198. return _IterCachedNonSymlink;
  199. }
  200. }();
  201. return __data;
  202. }
  203. _LIBCPP_HIDE_FROM_ABI void __assign_iter_entry(_Path&& __p, __cached_data __dt) {
  204. __p_ = std::move(__p);
  205. __data_ = __dt;
  206. }
  207. _LIBCPP_EXPORTED_FROM_ABI error_code __do_refresh() noexcept;
  208. _LIBCPP_HIDE_FROM_ABI static bool __is_dne_error(error_code const& __ec) {
  209. if (!__ec)
  210. return true;
  211. switch (static_cast<errc>(__ec.value())) {
  212. case errc::no_such_file_or_directory:
  213. case errc::not_a_directory:
  214. return true;
  215. default:
  216. return false;
  217. }
  218. }
  219. _LIBCPP_HIDE_FROM_ABI void
  220. __handle_error(const char* __msg, error_code* __dest_ec, error_code const& __ec, bool __allow_dne = false) const {
  221. if (__dest_ec) {
  222. *__dest_ec = __ec;
  223. return;
  224. }
  225. if (__ec && (!__allow_dne || !__is_dne_error(__ec)))
  226. __throw_filesystem_error(__msg, __p_, __ec);
  227. }
  228. _LIBCPP_HIDE_FROM_ABI void __refresh(error_code* __ec = nullptr) {
  229. __handle_error("in directory_entry::refresh",
  230. __ec,
  231. __do_refresh(),
  232. /*allow_dne*/ true);
  233. }
  234. _LIBCPP_HIDE_FROM_ABI file_type __get_sym_ft(error_code* __ec = nullptr) const {
  235. switch (__data_.__cache_type_) {
  236. case _Empty:
  237. return __symlink_status(__p_, __ec).type();
  238. case _IterSymlink:
  239. case _IterCachedSymlink:
  240. case _RefreshSymlink:
  241. case _RefreshSymlinkUnresolved:
  242. if (__ec)
  243. __ec->clear();
  244. return file_type::symlink;
  245. case _IterCachedNonSymlink:
  246. case _IterNonSymlink:
  247. case _RefreshNonSymlink: {
  248. file_status __st(__data_.__type_);
  249. if (__ec && !filesystem::exists(__st))
  250. *__ec = make_error_code(errc::no_such_file_or_directory);
  251. else if (__ec)
  252. __ec->clear();
  253. return __data_.__type_;
  254. }
  255. }
  256. __libcpp_unreachable();
  257. }
  258. _LIBCPP_HIDE_FROM_ABI file_type __get_ft(error_code* __ec = nullptr) const {
  259. switch (__data_.__cache_type_) {
  260. case _Empty:
  261. case _IterSymlink:
  262. case _IterCachedSymlink:
  263. case _RefreshSymlinkUnresolved:
  264. return __status(__p_, __ec).type();
  265. case _IterCachedNonSymlink:
  266. case _IterNonSymlink:
  267. case _RefreshNonSymlink:
  268. case _RefreshSymlink: {
  269. file_status __st(__data_.__type_);
  270. if (__ec && !filesystem::exists(__st))
  271. *__ec = make_error_code(errc::no_such_file_or_directory);
  272. else if (__ec)
  273. __ec->clear();
  274. return __data_.__type_;
  275. }
  276. }
  277. __libcpp_unreachable();
  278. }
  279. _LIBCPP_HIDE_FROM_ABI file_status __get_status(error_code* __ec = nullptr) const {
  280. switch (__data_.__cache_type_) {
  281. case _Empty:
  282. case _IterNonSymlink:
  283. case _IterSymlink:
  284. case _IterCachedSymlink:
  285. case _RefreshSymlinkUnresolved:
  286. return __status(__p_, __ec);
  287. case _IterCachedNonSymlink:
  288. case _RefreshNonSymlink:
  289. case _RefreshSymlink:
  290. return file_status(__get_ft(__ec), __data_.__non_sym_perms_);
  291. }
  292. __libcpp_unreachable();
  293. }
  294. _LIBCPP_HIDE_FROM_ABI file_status __get_symlink_status(error_code* __ec = nullptr) const {
  295. switch (__data_.__cache_type_) {
  296. case _Empty:
  297. case _IterNonSymlink:
  298. case _IterSymlink:
  299. return __symlink_status(__p_, __ec);
  300. case _IterCachedNonSymlink:
  301. case _RefreshNonSymlink:
  302. return file_status(__get_sym_ft(__ec), __data_.__non_sym_perms_);
  303. case _IterCachedSymlink:
  304. case _RefreshSymlink:
  305. case _RefreshSymlinkUnresolved:
  306. return file_status(__get_sym_ft(__ec), __data_.__sym_perms_);
  307. }
  308. __libcpp_unreachable();
  309. }
  310. _LIBCPP_HIDE_FROM_ABI uintmax_t __get_size(error_code* __ec = nullptr) const {
  311. switch (__data_.__cache_type_) {
  312. case _Empty:
  313. case _IterNonSymlink:
  314. case _IterSymlink:
  315. case _IterCachedSymlink:
  316. case _RefreshSymlinkUnresolved:
  317. return filesystem::__file_size(__p_, __ec);
  318. case _IterCachedNonSymlink:
  319. case _RefreshSymlink:
  320. case _RefreshNonSymlink: {
  321. error_code __m_ec;
  322. file_status __st(__get_ft(&__m_ec));
  323. __handle_error("in directory_entry::file_size", __ec, __m_ec);
  324. if (filesystem::exists(__st) && !filesystem::is_regular_file(__st)) {
  325. errc __err_kind = filesystem::is_directory(__st) ? errc::is_a_directory : errc::not_supported;
  326. __handle_error("in directory_entry::file_size", __ec, make_error_code(__err_kind));
  327. }
  328. return __data_.__size_;
  329. }
  330. }
  331. __libcpp_unreachable();
  332. }
  333. _LIBCPP_HIDE_FROM_ABI uintmax_t __get_nlink(error_code* __ec = nullptr) const {
  334. switch (__data_.__cache_type_) {
  335. case _Empty:
  336. case _IterNonSymlink:
  337. case _IterSymlink:
  338. case _IterCachedNonSymlink:
  339. case _IterCachedSymlink:
  340. case _RefreshSymlinkUnresolved:
  341. return filesystem::__hard_link_count(__p_, __ec);
  342. case _RefreshSymlink:
  343. case _RefreshNonSymlink: {
  344. error_code __m_ec;
  345. (void)__get_ft(&__m_ec);
  346. __handle_error("in directory_entry::hard_link_count", __ec, __m_ec);
  347. return __data_.__nlink_;
  348. }
  349. }
  350. __libcpp_unreachable();
  351. }
  352. _LIBCPP_HIDE_FROM_ABI file_time_type __get_write_time(error_code* __ec = nullptr) const {
  353. switch (__data_.__cache_type_) {
  354. case _Empty:
  355. case _IterNonSymlink:
  356. case _IterSymlink:
  357. case _IterCachedSymlink:
  358. case _RefreshSymlinkUnresolved:
  359. return filesystem::__last_write_time(__p_, __ec);
  360. case _IterCachedNonSymlink:
  361. case _RefreshSymlink:
  362. case _RefreshNonSymlink: {
  363. error_code __m_ec;
  364. file_status __st(__get_ft(&__m_ec));
  365. __handle_error("in directory_entry::last_write_time", __ec, __m_ec);
  366. if (filesystem::exists(__st) && __data_.__write_time_ == file_time_type::min())
  367. __handle_error("in directory_entry::last_write_time", __ec, make_error_code(errc::value_too_large));
  368. return __data_.__write_time_;
  369. }
  370. }
  371. __libcpp_unreachable();
  372. }
  373. private:
  374. _Path __p_;
  375. __cached_data __data_;
  376. };
  377. class __dir_element_proxy {
  378. public:
  379. inline _LIBCPP_HIDE_FROM_ABI directory_entry operator*() { return std::move(__elem_); }
  380. private:
  381. friend class directory_iterator;
  382. friend class recursive_directory_iterator;
  383. _LIBCPP_HIDE_FROM_ABI explicit __dir_element_proxy(directory_entry const& __e) : __elem_(__e) {}
  384. _LIBCPP_HIDE_FROM_ABI __dir_element_proxy(__dir_element_proxy&& __o) : __elem_(std::move(__o.__elem_)) {}
  385. directory_entry __elem_;
  386. };
  387. _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
  388. _LIBCPP_END_NAMESPACE_FILESYSTEM
  389. #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
  390. _LIBCPP_POP_MACROS
  391. #endif // _LIBCPP___FILESYSTEM_DIRECTORY_ENTRY_H