libcxx/include/__filesystem/operations.h

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