libstdc++
experimental/bits/fs_ops.h
Go to the documentation of this file.
1 // Filesystem operational functions -*- C++ -*-
2 
3 // Copyright (C) 2014-2020 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 experimental/bits/fs_ops.h
26  * This is an internal header file, included by other library headers.
27  * Do not attempt to use it directly. @headername{experimental/filesystem}
28  */
29 
30 #ifndef _GLIBCXX_EXPERIMENTAL_FS_OPS_H
31 #define _GLIBCXX_EXPERIMENTAL_FS_OPS_H 1
32 
33 #if __cplusplus < 201103L
34 # include <bits/c++0x_warning.h>
35 #else
36 
37 #include <cstdint>
38 
39 namespace std _GLIBCXX_VISIBILITY(default)
40 {
41 _GLIBCXX_BEGIN_NAMESPACE_VERSION
42 
43 namespace experimental
44 {
45 namespace filesystem
46 {
47 inline namespace v1
48 {
49  /**
50  * @addtogroup filesystem-ts
51  * @{
52  */
53 
54  path absolute(const path& __p, const path& __base = current_path());
55 
56  path canonical(const path& __p, const path& __base = current_path());
57  path canonical(const path& __p, error_code& __ec);
58  path canonical(const path& __p, const path& __base, error_code& __ec);
59 
60  inline void
61  copy(const path& __from, const path& __to)
62  { copy(__from, __to, copy_options::none); }
63 
64  inline void
65  copy(const path& __from, const path& __to, error_code& __ec) noexcept
66  { copy(__from, __to, copy_options::none, __ec); }
67 
68  void copy(const path& __from, const path& __to, copy_options __options);
69  void copy(const path& __from, const path& __to, copy_options __options,
70  error_code& __ec) noexcept;
71 
72  inline bool
73  copy_file(const path& __from, const path& __to)
74  { return copy_file(__from, __to, copy_options::none); }
75 
76  inline bool
77  copy_file(const path& __from, const path& __to, error_code& __ec)
78  { return copy_file(__from, __to, copy_options::none, __ec); }
79 
80  bool copy_file(const path& __from, const path& __to, copy_options __option);
81  bool copy_file(const path& __from, const path& __to, copy_options __option,
82  error_code& __ec);
83 
84  void copy_symlink(const path& __existing_symlink, const path& __new_symlink);
85  void copy_symlink(const path& __existing_symlink, const path& __new_symlink,
86  error_code& __ec) noexcept;
87 
88  bool create_directories(const path& __p);
89  bool create_directories(const path& __p, error_code& __ec);
90 
91  bool create_directory(const path& __p);
92  bool create_directory(const path& __p, error_code& __ec) noexcept;
93 
94  bool create_directory(const path& __p, const path& attributes);
95  bool create_directory(const path& __p, const path& attributes,
96  error_code& __ec) noexcept;
97 
98  void create_directory_symlink(const path& __to, const path& __new_symlink);
99  void create_directory_symlink(const path& __to, const path& __new_symlink,
100  error_code& __ec) noexcept;
101 
102  void create_hard_link(const path& __to, const path& __new_hard_link);
103  void create_hard_link(const path& __to, const path& __new_hard_link,
104  error_code& __ec) noexcept;
105 
106  void create_symlink(const path& __to, const path& __new_symlink);
107  void create_symlink(const path& __to, const path& __new_symlink,
108  error_code& __ec) noexcept;
109 
110  path current_path();
111  path current_path(error_code& __ec);
112  void current_path(const path& __p);
113  void current_path(const path& __p, error_code& __ec) noexcept;
114 
115  bool
116  equivalent(const path& __p1, const path& __p2);
117 
118  bool
119  equivalent(const path& __p1, const path& __p2, error_code& __ec) noexcept;
120 
121  inline bool
122  exists(file_status __s) noexcept
123  { return status_known(__s) && __s.type() != file_type::not_found; }
124 
125  inline bool
126  exists(const path& __p)
127  { return exists(status(__p)); }
128 
129  inline bool
130  exists(const path& __p, error_code& __ec) noexcept
131  {
132  auto __s = status(__p, __ec);
133  if (status_known(__s))
134  {
135  __ec.clear();
136  return __s.type() != file_type::not_found;
137  }
138  return false;
139  }
140 
141  uintmax_t file_size(const path& __p);
142  uintmax_t file_size(const path& __p, error_code& __ec) noexcept;
143 
144  uintmax_t hard_link_count(const path& __p);
145  uintmax_t hard_link_count(const path& __p, error_code& __ec) noexcept;
146 
147  inline bool
148  is_block_file(file_status __s) noexcept
149  { return __s.type() == file_type::block; }
150 
151  inline bool
152  is_block_file(const path& __p)
153  { return is_block_file(status(__p)); }
154 
155  inline bool
156  is_block_file(const path& __p, error_code& __ec) noexcept
157  { return is_block_file(status(__p, __ec)); }
158 
159  inline bool
160  is_character_file(file_status __s) noexcept
161  { return __s.type() == file_type::character; }
162 
163  inline bool
164  is_character_file(const path& __p)
165  { return is_character_file(status(__p)); }
166 
167  inline bool
168  is_character_file(const path& __p, error_code& __ec) noexcept
169  { return is_character_file(status(__p, __ec)); }
170 
171  inline bool
172  is_directory(file_status __s) noexcept
173  { return __s.type() == file_type::directory; }
174 
175  inline bool
176  is_directory(const path& __p)
177  { return is_directory(status(__p)); }
178 
179  inline bool
180  is_directory(const path& __p, error_code& __ec) noexcept
181  { return is_directory(status(__p, __ec)); }
182 
183  bool is_empty(const path& __p);
184  bool is_empty(const path& __p, error_code& __ec) noexcept;
185 
186  inline bool
187  is_fifo(file_status __s) noexcept
188  { return __s.type() == file_type::fifo; }
189 
190  inline bool
191  is_fifo(const path& __p)
192  { return is_fifo(status(__p)); }
193 
194  inline bool
195  is_fifo(const path& __p, error_code& __ec) noexcept
196  { return is_fifo(status(__p, __ec)); }
197 
198  inline bool
199  is_other(file_status __s) noexcept
200  {
201  return exists(__s) && !is_regular_file(__s) && !is_directory(__s)
202  && !is_symlink(__s);
203  }
204 
205  inline bool
206  is_other(const path& __p)
207  { return is_other(status(__p)); }
208 
209  inline bool
210  is_other(const path& __p, error_code& __ec) noexcept
211  { return is_other(status(__p, __ec)); }
212 
213  inline bool
214  is_regular_file(file_status __s) noexcept
215  { return __s.type() == file_type::regular; }
216 
217  inline bool
218  is_regular_file(const path& __p)
219  { return is_regular_file(status(__p)); }
220 
221  inline bool
222  is_regular_file(const path& __p, error_code& __ec) noexcept
223  { return is_regular_file(status(__p, __ec)); }
224 
225  inline bool
226  is_socket(file_status __s) noexcept
227  { return __s.type() == file_type::socket; }
228 
229  inline bool
230  is_socket(const path& __p)
231  { return is_socket(status(__p)); }
232 
233  inline bool
234  is_socket(const path& __p, error_code& __ec) noexcept
235  { return is_socket(status(__p, __ec)); }
236 
237  inline bool
238  is_symlink(file_status __s) noexcept
239  { return __s.type() == file_type::symlink; }
240 
241  inline bool
242  is_symlink(const path& __p)
243  { return is_symlink(symlink_status(__p)); }
244 
245  inline bool
246  is_symlink(const path& __p, error_code& __ec) noexcept
247  { return is_symlink(symlink_status(__p, __ec)); }
248 
249  file_time_type last_write_time(const path& __p);
250  file_time_type last_write_time(const path& __p, error_code& __ec) noexcept;
251  void last_write_time(const path& __p, file_time_type __new_time);
252  void last_write_time(const path& __p, file_time_type __new_time,
253  error_code& __ec) noexcept;
254 
255  void permissions(const path& __p, perms __prms);
256  void permissions(const path& __p, perms __prms, error_code& __ec) noexcept;
257 
258  path read_symlink(const path& __p);
259  path read_symlink(const path& __p, error_code& __ec);
260 
261  bool remove(const path& __p);
262  bool remove(const path& __p, error_code& __ec) noexcept;
263 
264  uintmax_t remove_all(const path& __p);
265  uintmax_t remove_all(const path& __p, error_code& __ec);
266 
267  void rename(const path& __from, const path& __to);
268  void rename(const path& __from, const path& __to, error_code& __ec) noexcept;
269 
270  void resize_file(const path& __p, uintmax_t __size);
271  void resize_file(const path& __p, uintmax_t __size, error_code& __ec) noexcept;
272 
273  space_info space(const path& __p);
274  space_info space(const path& __p, error_code& __ec) noexcept;
275 
276  file_status status(const path& __p);
277  file_status status(const path& __p, error_code& __ec) noexcept;
278 
279  inline bool status_known(file_status __s) noexcept
280  { return __s.type() != file_type::none; }
281 
282  file_status symlink_status(const path& __p);
283  file_status symlink_status(const path& __p, error_code& __ec) noexcept;
284 
285  path system_complete(const path& __p);
286  path system_complete(const path& __p, error_code& __ec);
287 
288  path temp_directory_path();
289  path temp_directory_path(error_code& __ec);
290 
291  /// @} group filesystem-ts
292 } // namespace v1
293 } // namespace filesystem
294 } // namespace experimental
295 
296 _GLIBCXX_END_NAMESPACE_VERSION
297 } // namespace std
298 
299 #endif // C++11
300 
301 #endif // _GLIBCXX_EXPERIMENTAL_FS_OPS_H
std
ISO C++ entities toplevel namespace is std.
__gnu_debug::__base
constexpr _Iterator __base(_Iterator __it)
Definition: helper_functions.h:311