operations.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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_OPERATIONS_H
  10. #define _LIBCPP___FILESYSTEM_OPERATIONS_H
  11. #include <__availability>
  12. #include <__chrono/time_point.h>
  13. #include <__config>
  14. #include <__filesystem/copy_options.h>
  15. #include <__filesystem/file_status.h>
  16. #include <__filesystem/file_time_type.h>
  17. #include <__filesystem/file_type.h>
  18. #include <__filesystem/path.h>
  19. #include <__filesystem/perm_options.h>
  20. #include <__filesystem/perms.h>
  21. #include <__filesystem/space_info.h>
  22. #include <__system_error/error_code.h>
  23. #include <cstdint>
  24. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  25. # pragma GCC system_header
  26. #endif
  27. #if _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
  28. _LIBCPP_BEGIN_NAMESPACE_FILESYSTEM
  29. _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_PUSH
  30. _LIBCPP_EXPORTED_FROM_ABI path __absolute(const path&, error_code* __ec = nullptr);
  31. _LIBCPP_EXPORTED_FROM_ABI path __canonical(const path&, error_code* __ec = nullptr);
  32. _LIBCPP_EXPORTED_FROM_ABI bool
  33. __copy_file(const path& __from, const path& __to, copy_options __opt, error_code* __ec = nullptr);
  34. _LIBCPP_EXPORTED_FROM_ABI void
  35. __copy_symlink(const path& __existing_symlink, const path& __new_symlink, error_code* __ec = nullptr);
  36. _LIBCPP_EXPORTED_FROM_ABI void
  37. __copy(const path& __from, const path& __to, copy_options __opt, error_code* __ec = nullptr);
  38. _LIBCPP_EXPORTED_FROM_ABI bool __create_directories(const path&, error_code* = nullptr);
  39. _LIBCPP_EXPORTED_FROM_ABI void
  40. __create_directory_symlink(const path& __to, const path& __new_symlink, error_code* __ec = nullptr);
  41. _LIBCPP_EXPORTED_FROM_ABI bool __create_directory(const path&, error_code* = nullptr);
  42. _LIBCPP_EXPORTED_FROM_ABI bool __create_directory(const path&, const path& __attributes, error_code* = nullptr);
  43. _LIBCPP_EXPORTED_FROM_ABI void
  44. __create_hard_link(const path& __to, const path& __new_hard_link, error_code* __ec = nullptr);
  45. _LIBCPP_EXPORTED_FROM_ABI void
  46. __create_symlink(const path& __to, const path& __new_symlink, error_code* __ec = nullptr);
  47. _LIBCPP_EXPORTED_FROM_ABI path __current_path(error_code* __ec = nullptr);
  48. _LIBCPP_EXPORTED_FROM_ABI void __current_path(const path&, error_code* __ec = nullptr);
  49. _LIBCPP_EXPORTED_FROM_ABI bool __equivalent(const path&, const path&, error_code* __ec = nullptr);
  50. _LIBCPP_EXPORTED_FROM_ABI file_status __status(const path&, error_code* __ec = nullptr);
  51. _LIBCPP_EXPORTED_FROM_ABI uintmax_t __file_size(const path&, error_code* __ec = nullptr);
  52. _LIBCPP_EXPORTED_FROM_ABI uintmax_t __hard_link_count(const path&, error_code* __ec = nullptr);
  53. _LIBCPP_EXPORTED_FROM_ABI file_status __symlink_status(const path&, error_code* __ec = nullptr);
  54. _LIBCPP_EXPORTED_FROM_ABI file_time_type __last_write_time(const path&, error_code* __ec = nullptr);
  55. _LIBCPP_EXPORTED_FROM_ABI void __last_write_time(const path&, file_time_type __new_time, error_code* __ec = nullptr);
  56. _LIBCPP_EXPORTED_FROM_ABI path __weakly_canonical(path const& __p, error_code* __ec = nullptr);
  57. _LIBCPP_EXPORTED_FROM_ABI path __read_symlink(const path&, error_code* __ec = nullptr);
  58. _LIBCPP_EXPORTED_FROM_ABI uintmax_t __remove_all(const path&, error_code* __ec = nullptr);
  59. _LIBCPP_EXPORTED_FROM_ABI bool __remove(const path&, error_code* __ec = nullptr);
  60. _LIBCPP_EXPORTED_FROM_ABI void __rename(const path& __from, const path& __to, error_code* __ec = nullptr);
  61. _LIBCPP_EXPORTED_FROM_ABI void __resize_file(const path&, uintmax_t __size, error_code* = nullptr);
  62. _LIBCPP_EXPORTED_FROM_ABI path __temp_directory_path(error_code* __ec = nullptr);
  63. inline _LIBCPP_HIDE_FROM_ABI path absolute(const path& __p) { return __absolute(__p); }
  64. inline _LIBCPP_HIDE_FROM_ABI path absolute(const path& __p, error_code& __ec) { return __absolute(__p, &__ec); }
  65. inline _LIBCPP_HIDE_FROM_ABI path canonical(const path& __p) { return __canonical(__p); }
  66. inline _LIBCPP_HIDE_FROM_ABI path canonical(const path& __p, error_code& __ec) { return __canonical(__p, &__ec); }
  67. inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to) {
  68. return __copy_file(__from, __to, copy_options::none);
  69. }
  70. inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to, error_code& __ec) {
  71. return __copy_file(__from, __to, copy_options::none, &__ec);
  72. }
  73. inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to, copy_options __opt) {
  74. return __copy_file(__from, __to, __opt);
  75. }
  76. inline _LIBCPP_HIDE_FROM_ABI bool
  77. copy_file(const path& __from, const path& __to, copy_options __opt, error_code& __ec) {
  78. return __copy_file(__from, __to, __opt, &__ec);
  79. }
  80. inline _LIBCPP_HIDE_FROM_ABI void copy_symlink(const path& __from, const path& __to) { __copy_symlink(__from, __to); }
  81. inline _LIBCPP_HIDE_FROM_ABI void copy_symlink(const path& __from, const path& __to, error_code& __ec) noexcept {
  82. __copy_symlink(__from, __to, &__ec);
  83. }
  84. inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to) {
  85. __copy(__from, __to, copy_options::none);
  86. }
  87. inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, error_code& __ec) {
  88. __copy(__from, __to, copy_options::none, &__ec);
  89. }
  90. inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, copy_options __opt) {
  91. __copy(__from, __to, __opt);
  92. }
  93. inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, copy_options __opt, error_code& __ec) {
  94. __copy(__from, __to, __opt, &__ec);
  95. }
  96. inline _LIBCPP_HIDE_FROM_ABI bool create_directories(const path& __p) { return __create_directories(__p); }
  97. inline _LIBCPP_HIDE_FROM_ABI bool create_directories(const path& __p, error_code& __ec) {
  98. return __create_directories(__p, &__ec);
  99. }
  100. inline _LIBCPP_HIDE_FROM_ABI void create_directory_symlink(const path& __target, const path& __link) {
  101. __create_directory_symlink(__target, __link);
  102. }
  103. inline _LIBCPP_HIDE_FROM_ABI void
  104. create_directory_symlink(const path& __target, const path& __link, error_code& __ec) noexcept {
  105. __create_directory_symlink(__target, __link, &__ec);
  106. }
  107. inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p) { return __create_directory(__p); }
  108. inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, error_code& __ec) noexcept {
  109. return __create_directory(__p, &__ec);
  110. }
  111. inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, const path& __attrs) {
  112. return __create_directory(__p, __attrs);
  113. }
  114. inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, const path& __attrs, error_code& __ec) noexcept {
  115. return __create_directory(__p, __attrs, &__ec);
  116. }
  117. inline _LIBCPP_HIDE_FROM_ABI void create_hard_link(const path& __target, const path& __link) {
  118. __create_hard_link(__target, __link);
  119. }
  120. inline _LIBCPP_HIDE_FROM_ABI void
  121. create_hard_link(const path& __target, const path& __link, error_code& __ec) noexcept {
  122. __create_hard_link(__target, __link, &__ec);
  123. }
  124. inline _LIBCPP_HIDE_FROM_ABI void create_symlink(const path& __target, const path& __link) {
  125. __create_symlink(__target, __link);
  126. }
  127. inline _LIBCPP_HIDE_FROM_ABI void create_symlink(const path& __target, const path& __link, error_code& __ec) noexcept {
  128. return __create_symlink(__target, __link, &__ec);
  129. }
  130. inline _LIBCPP_HIDE_FROM_ABI path current_path() { return __current_path(); }
  131. inline _LIBCPP_HIDE_FROM_ABI path current_path(error_code& __ec) { return __current_path(&__ec); }
  132. inline _LIBCPP_HIDE_FROM_ABI void current_path(const path& __p) { __current_path(__p); }
  133. inline _LIBCPP_HIDE_FROM_ABI void current_path(const path& __p, error_code& __ec) noexcept {
  134. __current_path(__p, &__ec);
  135. }
  136. inline _LIBCPP_HIDE_FROM_ABI bool equivalent(const path& __p1, const path& __p2) { return __equivalent(__p1, __p2); }
  137. inline _LIBCPP_HIDE_FROM_ABI bool equivalent(const path& __p1, const path& __p2, error_code& __ec) noexcept {
  138. return __equivalent(__p1, __p2, &__ec);
  139. }
  140. inline _LIBCPP_HIDE_FROM_ABI bool status_known(file_status __s) noexcept { return __s.type() != file_type::none; }
  141. inline _LIBCPP_HIDE_FROM_ABI bool exists(file_status __s) noexcept {
  142. return status_known(__s) && __s.type() != file_type::not_found;
  143. }
  144. inline _LIBCPP_HIDE_FROM_ABI bool exists(const path& __p) { return exists(__status(__p)); }
  145. inline _LIBCPP_HIDE_FROM_ABI bool exists(const path& __p, error_code& __ec) noexcept {
  146. auto __s = __status(__p, &__ec);
  147. if (status_known(__s))
  148. __ec.clear();
  149. return exists(__s);
  150. }
  151. inline _LIBCPP_HIDE_FROM_ABI uintmax_t file_size(const path& __p) { return __file_size(__p); }
  152. inline _LIBCPP_HIDE_FROM_ABI uintmax_t file_size(const path& __p, error_code& __ec) noexcept {
  153. return __file_size(__p, &__ec);
  154. }
  155. inline _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count(const path& __p) { return __hard_link_count(__p); }
  156. inline _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count(const path& __p, error_code& __ec) noexcept {
  157. return __hard_link_count(__p, &__ec);
  158. }
  159. inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(file_status __s) noexcept { return __s.type() == file_type::block; }
  160. inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(const path& __p) { return is_block_file(__status(__p)); }
  161. inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(const path& __p, error_code& __ec) noexcept {
  162. return is_block_file(__status(__p, &__ec));
  163. }
  164. inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(file_status __s) noexcept {
  165. return __s.type() == file_type::character;
  166. }
  167. inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(const path& __p) { return is_character_file(__status(__p)); }
  168. inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(const path& __p, error_code& __ec) noexcept {
  169. return is_character_file(__status(__p, &__ec));
  170. }
  171. inline _LIBCPP_HIDE_FROM_ABI bool is_directory(file_status __s) noexcept { return __s.type() == file_type::directory; }
  172. inline _LIBCPP_HIDE_FROM_ABI bool is_directory(const path& __p) { return is_directory(__status(__p)); }
  173. inline _LIBCPP_HIDE_FROM_ABI bool is_directory(const path& __p, error_code& __ec) noexcept {
  174. return is_directory(__status(__p, &__ec));
  175. }
  176. _LIBCPP_EXPORTED_FROM_ABI bool __fs_is_empty(const path& __p, error_code* __ec = nullptr);
  177. inline _LIBCPP_HIDE_FROM_ABI bool is_empty(const path& __p) { return __fs_is_empty(__p); }
  178. inline _LIBCPP_HIDE_FROM_ABI bool is_empty(const path& __p, error_code& __ec) { return __fs_is_empty(__p, &__ec); }
  179. inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(file_status __s) noexcept { return __s.type() == file_type::fifo; }
  180. inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(const path& __p) { return is_fifo(__status(__p)); }
  181. inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(const path& __p, error_code& __ec) noexcept {
  182. return is_fifo(__status(__p, &__ec));
  183. }
  184. inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(file_status __s) noexcept { return __s.type() == file_type::regular; }
  185. inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(const path& __p) { return is_regular_file(__status(__p)); }
  186. inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(const path& __p, error_code& __ec) noexcept {
  187. return is_regular_file(__status(__p, &__ec));
  188. }
  189. inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(file_status __s) noexcept { return __s.type() == file_type::symlink; }
  190. inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(const path& __p) { return is_symlink(__symlink_status(__p)); }
  191. inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(const path& __p, error_code& __ec) noexcept {
  192. return is_symlink(__symlink_status(__p, &__ec));
  193. }
  194. inline _LIBCPP_HIDE_FROM_ABI bool is_other(file_status __s) noexcept {
  195. return exists(__s) && !is_regular_file(__s) && !is_directory(__s) && !is_symlink(__s);
  196. }
  197. inline _LIBCPP_HIDE_FROM_ABI bool is_other(const path& __p) { return is_other(__status(__p)); }
  198. inline _LIBCPP_HIDE_FROM_ABI bool is_other(const path& __p, error_code& __ec) noexcept {
  199. return is_other(__status(__p, &__ec));
  200. }
  201. inline _LIBCPP_HIDE_FROM_ABI bool is_socket(file_status __s) noexcept { return __s.type() == file_type::socket; }
  202. inline _LIBCPP_HIDE_FROM_ABI bool is_socket(const path& __p) { return is_socket(__status(__p)); }
  203. inline _LIBCPP_HIDE_FROM_ABI bool is_socket(const path& __p, error_code& __ec) noexcept {
  204. return is_socket(__status(__p, &__ec));
  205. }
  206. inline _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time(const path& __p) { return __last_write_time(__p); }
  207. inline _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time(const path& __p, error_code& __ec) noexcept {
  208. return __last_write_time(__p, &__ec);
  209. }
  210. inline _LIBCPP_HIDE_FROM_ABI void last_write_time(const path& __p, file_time_type __t) { __last_write_time(__p, __t); }
  211. inline _LIBCPP_HIDE_FROM_ABI void last_write_time(const path& __p, file_time_type __t, error_code& __ec) noexcept {
  212. __last_write_time(__p, __t, &__ec);
  213. }
  214. _LIBCPP_EXPORTED_FROM_ABI void __permissions(const path&, perms, perm_options, error_code* = nullptr);
  215. inline _LIBCPP_HIDE_FROM_ABI void
  216. permissions(const path& __p, perms __prms, perm_options __opts = perm_options::replace) {
  217. __permissions(__p, __prms, __opts);
  218. }
  219. inline _LIBCPP_HIDE_FROM_ABI void permissions(const path& __p, perms __prms, error_code& __ec) noexcept {
  220. __permissions(__p, __prms, perm_options::replace, &__ec);
  221. }
  222. inline _LIBCPP_HIDE_FROM_ABI void permissions(const path& __p, perms __prms, perm_options __opts, error_code& __ec) {
  223. __permissions(__p, __prms, __opts, &__ec);
  224. }
  225. inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, const path& __base, error_code& __ec) {
  226. path __tmp = __weakly_canonical(__p, &__ec);
  227. if (__ec)
  228. return {};
  229. path __tmp_base = __weakly_canonical(__base, &__ec);
  230. if (__ec)
  231. return {};
  232. return __tmp.lexically_proximate(__tmp_base);
  233. }
  234. inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, error_code& __ec) {
  235. return proximate(__p, current_path(), __ec);
  236. }
  237. inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, const path& __base = current_path()) {
  238. return __weakly_canonical(__p).lexically_proximate(__weakly_canonical(__base));
  239. }
  240. inline _LIBCPP_HIDE_FROM_ABI path read_symlink(const path& __p) { return __read_symlink(__p); }
  241. inline _LIBCPP_HIDE_FROM_ABI path read_symlink(const path& __p, error_code& __ec) { return __read_symlink(__p, &__ec); }
  242. inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, const path& __base, error_code& __ec) {
  243. path __tmp = __weakly_canonical(__p, &__ec);
  244. if (__ec)
  245. return path();
  246. path __tmpbase = __weakly_canonical(__base, &__ec);
  247. if (__ec)
  248. return path();
  249. return __tmp.lexically_relative(__tmpbase);
  250. }
  251. inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, error_code& __ec) {
  252. return relative(__p, current_path(), __ec);
  253. }
  254. inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, const path& __base = current_path()) {
  255. return __weakly_canonical(__p).lexically_relative(__weakly_canonical(__base));
  256. }
  257. inline _LIBCPP_HIDE_FROM_ABI uintmax_t remove_all(const path& __p) { return __remove_all(__p); }
  258. inline _LIBCPP_HIDE_FROM_ABI uintmax_t remove_all(const path& __p, error_code& __ec) {
  259. return __remove_all(__p, &__ec);
  260. }
  261. inline _LIBCPP_HIDE_FROM_ABI bool remove(const path& __p) { return __remove(__p); }
  262. inline _LIBCPP_HIDE_FROM_ABI bool remove(const path& __p, error_code& __ec) noexcept { return __remove(__p, &__ec); }
  263. inline _LIBCPP_HIDE_FROM_ABI void rename(const path& __from, const path& __to) { return __rename(__from, __to); }
  264. inline _LIBCPP_HIDE_FROM_ABI void rename(const path& __from, const path& __to, error_code& __ec) noexcept {
  265. return __rename(__from, __to, &__ec);
  266. }
  267. inline _LIBCPP_HIDE_FROM_ABI void resize_file(const path& __p, uintmax_t __ns) { return __resize_file(__p, __ns); }
  268. inline _LIBCPP_HIDE_FROM_ABI void resize_file(const path& __p, uintmax_t __ns, error_code& __ec) noexcept {
  269. return __resize_file(__p, __ns, &__ec);
  270. }
  271. _LIBCPP_EXPORTED_FROM_ABI space_info __space(const path&, error_code* __ec = nullptr);
  272. inline _LIBCPP_HIDE_FROM_ABI space_info space(const path& __p) { return __space(__p); }
  273. inline _LIBCPP_HIDE_FROM_ABI space_info space(const path& __p, error_code& __ec) noexcept {
  274. return __space(__p, &__ec);
  275. }
  276. inline _LIBCPP_HIDE_FROM_ABI file_status status(const path& __p) { return __status(__p); }
  277. inline _LIBCPP_HIDE_FROM_ABI file_status status(const path& __p, error_code& __ec) noexcept {
  278. return __status(__p, &__ec);
  279. }
  280. inline _LIBCPP_HIDE_FROM_ABI file_status symlink_status(const path& __p) { return __symlink_status(__p); }
  281. inline _LIBCPP_HIDE_FROM_ABI file_status symlink_status(const path& __p, error_code& __ec) noexcept {
  282. return __symlink_status(__p, &__ec);
  283. }
  284. inline _LIBCPP_HIDE_FROM_ABI path temp_directory_path() { return __temp_directory_path(); }
  285. inline _LIBCPP_HIDE_FROM_ABI path temp_directory_path(error_code& __ec) { return __temp_directory_path(&__ec); }
  286. inline _LIBCPP_HIDE_FROM_ABI path weakly_canonical(path const& __p) { return __weakly_canonical(__p); }
  287. inline _LIBCPP_HIDE_FROM_ABI path weakly_canonical(path const& __p, error_code& __ec) {
  288. return __weakly_canonical(__p, &__ec);
  289. }
  290. _LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
  291. _LIBCPP_END_NAMESPACE_FILESYSTEM
  292. #endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
  293. #endif // _LIBCPP___FILESYSTEM_OPERATIONS_H