libstdc++-v3/include/bits/fs_ops.h

   1 // Filesystem operational functions -*- C++ -*-
   2
   3 // Copyright (C) 2014-2017 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 3, or (at your __option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 /** @file include/bits/fs_fwd.h
  26  *  This is an internal header file, included by other library headers.
  27  *  Do not attempt to use it directly. @headername{filesystem}
  28  */
  29
  30 #ifndef _GLIBCXX_FS_OPS_H
  31 #define _GLIBCXX_FS_OPS_H 1
  32
  33 #if __cplusplus >= 201703L
  34
  35 #include <cstdint>
  36
  37 namespace std _GLIBCXX_VISIBILITY(default)
  38 {
  39 _GLIBCXX_BEGIN_NAMESPACE_VERSION
  40
  41 namespace filesystem
  42 {
  43   /**
  44    * @ingroup filesystem
  45    * @{
  46    */
  47
  48   path absolute(const path& __p);
  49   path absolute(const path& __p, error_code& __ec);
  50
  51   path canonical(const path& __p);
  52   path canonical(const path& __p, error_code& __ec);
  53
  54   inline void
  55   copy(const path& __from, const path& __to)
  56   { copy(__from, __to, copy_options::none); }
  57
  58   inline void
  59   copy(const path& __from, const path& __to, error_code& __ec)
  60   { copy(__from, __to, copy_options::none, __ec); }
  61
  62   void copy(const path& __from, const path& __to, copy_options __options);
  63   void copy(const path& __from, const path& __to, copy_options __options,
  64             error_code& __ec);
  65
  66   inline bool
  67   copy_file(const path& __from, const path& __to)
  68   { return copy_file(__from, __to, copy_options::none); }
  69
  70   inline bool
  71   copy_file(const path& __from, const path& __to, error_code& __ec)
  72   { return copy_file(__from, __to, copy_options::none, __ec); }
  73
  74   bool copy_file(const path& __from, const path& __to, copy_options __option);
  75   bool copy_file(const path& __from, const path& __to, copy_options __option,
  76                  error_code& __ec);
  77
  78   void copy_symlink(const path& __existing_symlink, const path& __new_symlink);
  79   void copy_symlink(const path& __existing_symlink, const path& __new_symlink,
  80                     error_code& __ec) noexcept;
  81
  82   bool create_directories(const path& __p);
  83   bool create_directories(const path& __p, error_code& __ec);
  84
  85   bool create_directory(const path& __p);
  86   bool create_directory(const path& __p, error_code& __ec) noexcept;
  87
  88   bool create_directory(const path& __p, const path& attributes);
  89   bool create_directory(const path& __p, const path& attributes,
  90                         error_code& __ec) noexcept;
  91
  92   void create_directory_symlink(const path& __to, const path& __new_symlink);
  93   void create_directory_symlink(const path& __to, const path& __new_symlink,
  94                                 error_code& __ec) noexcept;
  95
  96   void create_hard_link(const path& __to, const path& __new_hard_link);
  97   void create_hard_link(const path& __to, const path& __new_hard_link,
  98                         error_code& __ec) noexcept;
  99
 100   void create_symlink(const path& __to, const path& __new_symlink);
 101   void create_symlink(const path& __to, const path& __new_symlink,
 102                       error_code& __ec) noexcept;
 103
 104   path current_path();
 105   path current_path(error_code& __ec);
 106   void current_path(const path& __p);
 107   void current_path(const path& __p, error_code& __ec) noexcept;
 108
 109   bool
 110   equivalent(const path& __p1, const path& __p2);
 111
 112   bool
 113   equivalent(const path& __p1, const path& __p2, error_code& __ec) noexcept;
 114
 115   inline bool
 116   exists(file_status __s) noexcept
 117   { return status_known(__s) && __s.type() != file_type::not_found; }
 118
 119   inline bool
 120   exists(const path& __p)
 121   { return exists(status(__p)); }
 122
 123   inline bool
 124   exists(const path& __p, error_code& __ec) noexcept
 125   {
 126     auto __s = status(__p, __ec);
 127     if (status_known(__s))
 128       __ec.clear();
 129     return exists(__s);
 130   }
 131
 132   uintmax_t file_size(const path& __p);
 133   uintmax_t file_size(const path& __p, error_code& __ec) noexcept;
 134
 135   uintmax_t hard_link_count(const path& __p);
 136   uintmax_t hard_link_count(const path& __p, error_code& __ec) noexcept;
 137
 138   inline bool
 139   is_block_file(file_status __s) noexcept
 140   { return __s.type() == file_type::block; }
 141
 142   inline bool
 143   is_block_file(const path& __p)
 144   { return is_block_file(status(__p)); }
 145
 146   inline bool
 147   is_block_file(const path& __p, error_code& __ec) noexcept
 148   { return is_block_file(status(__p, __ec)); }
 149
 150   inline bool
 151   is_character_file(file_status __s) noexcept
 152   { return __s.type() == file_type::character; }
 153
 154   inline bool
 155   is_character_file(const path& __p)
 156   { return is_character_file(status(__p)); }
 157
 158   inline bool
 159   is_character_file(const path& __p, error_code& __ec) noexcept
 160   { return is_character_file(status(__p, __ec)); }
 161
 162   inline bool
 163   is_directory(file_status __s) noexcept
 164   { return __s.type() == file_type::directory; }
 165
 166   inline bool
 167   is_directory(const path& __p)
 168   { return is_directory(status(__p)); }
 169
 170   inline bool
 171   is_directory(const path& __p, error_code& __ec) noexcept
 172   { return is_directory(status(__p, __ec)); }
 173
 174   bool is_empty(const path& __p);
 175   bool is_empty(const path& __p, error_code& __ec);
 176
 177   inline bool
 178   is_fifo(file_status __s) noexcept
 179   { return __s.type() == file_type::fifo; }
 180
 181   inline bool
 182   is_fifo(const path& __p)
 183   { return is_fifo(status(__p)); }
 184
 185   inline bool
 186   is_fifo(const path& __p, error_code& __ec) noexcept
 187   { return is_fifo(status(__p, __ec)); }
 188
 189   inline bool
 190   is_other(file_status __s) noexcept
 191   {
 192     return exists(__s) && !is_regular_file(__s) && !is_directory(__s)
 193       && !is_symlink(__s);
 194   }
 195
 196   inline bool
 197   is_other(const path& __p)
 198   { return is_other(status(__p)); }
 199
 200   inline bool
 201   is_other(const path& __p, error_code& __ec) noexcept
 202   { return is_other(status(__p, __ec)); }
 203
 204   inline bool
 205   is_regular_file(file_status __s) noexcept
 206   { return __s.type() == file_type::regular; }
 207
 208   inline bool
 209   is_regular_file(const path& __p)
 210   { return is_regular_file(status(__p)); }
 211
 212   inline bool
 213   is_regular_file(const path& __p, error_code& __ec) noexcept
 214   { return is_regular_file(status(__p, __ec)); }
 215
 216   inline bool
 217   is_socket(file_status __s) noexcept
 218   { return __s.type() == file_type::socket; }
 219
 220   inline bool
 221   is_socket(const path& __p)
 222   { return is_socket(status(__p)); }
 223
 224   inline bool
 225   is_socket(const path& __p, error_code& __ec) noexcept
 226   { return is_socket(status(__p, __ec)); }
 227
 228   inline bool
 229   is_symlink(file_status __s) noexcept
 230   { return __s.type() == file_type::symlink; }
 231
 232   inline bool
 233   is_symlink(const path& __p)
 234   { return is_symlink(symlink_status(__p)); }
 235
 236   inline bool
 237   is_symlink(const path& __p, error_code& __ec) noexcept
 238   { return is_symlink(symlink_status(__p, __ec)); }
 239
 240   file_time_type  last_write_time(const path& __p);
 241   file_time_type  last_write_time(const path& __p, error_code& __ec) noexcept;
 242   void last_write_time(const path& __p, file_time_type __new_time);
 243   void last_write_time(const path& __p, file_time_type __new_time,
 244                        error_code& __ec) noexcept;
 245
 246   void
 247   permissions(const path& __p, perms __prms,
 248               perm_options __opts = perm_options::replace);
 249
 250   inline void
 251   permissions(const path& __p, perms __prms, error_code& __ec) noexcept
 252   { permissions(__p, __prms, perm_options::replace, __ec); }
 253
 254   void
 255   permissions(const path& __p, perms __prms, perm_options __opts,
 256               error_code& __ec);
 257
 258   inline path proximate(const path& __p, error_code& __ec)
 259   { return proximate(__p, current_path(), __ec); }
 260
 261   path proximate(const path& __p, const path& __base = current_path());
 262   path proximate(const path& __p, const path& __base, error_code& __ec);
 263
 264   path read_symlink(const path& __p);
 265   path read_symlink(const path& __p, error_code& __ec);
 266
 267   inline path relative(const path& __p, error_code& __ec)
 268   { return relative(__p, current_path(), __ec); }
 269
 270   path relative(const path& __p, const path& __base = current_path());
 271   path relative(const path& __p, const path& __base, error_code& __ec);
 272
 273   bool remove(const path& __p);
 274   bool remove(const path& __p, error_code& __ec) noexcept;
 275
 276   uintmax_t remove_all(const path& __p);
 277   uintmax_t remove_all(const path& __p, error_code& __ec);
 278
 279   void rename(const path& __from, const path& __to);
 280   void rename(const path& __from, const path& __to, error_code& __ec) noexcept;
 281
 282   void resize_file(const path& __p, uintmax_t __size);
 283   void resize_file(const path& __p, uintmax_t __size, error_code& __ec) noexcept;
 284
 285   space_info space(const path& __p);
 286   space_info space(const path& __p, error_code& __ec) noexcept;
 287
 288   file_status status(const path& __p);
 289   file_status status(const path& __p, error_code& __ec) noexcept;
 290
 291   inline bool status_known(file_status __s) noexcept
 292   { return __s.type() != file_type::none; }
 293
 294   file_status symlink_status(const path& __p);
 295   file_status symlink_status(const path& __p, error_code& __ec) noexcept;
 296
 297   path temp_directory_path();
 298   path temp_directory_path(error_code& __ec);
 299
 300   path weakly_canonical(const path& __p);
 301   path weakly_canonical(const path& __p, error_code& __ec);
 302
 303   // @} group filesystem
 304 } // namespace filesystem
 305
 306 _GLIBCXX_END_NAMESPACE_VERSION
 307 } // namespace std
 308
 309 #endif // C++17
 310
 311 #endif // _GLIBCXX_FS_OPS_H