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 && !defined(_LIBCPP_HAS_NO_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
70inline _LIBCPP_HIDE_FROM_ABI path absolute(const path& __p) { return __absolute(__p); }
71inline _LIBCPP_HIDE_FROM_ABI path absolute(const path& __p, error_code& __ec) { return __absolute(__p, ec: &__ec); }
72inline _LIBCPP_HIDE_FROM_ABI path canonical(const path& __p) { return __canonical(__p); }
73inline _LIBCPP_HIDE_FROM_ABI path canonical(const path& __p, error_code& __ec) { return __canonical(__p, ec: &__ec); }
74inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to) {
75 return __copy_file(__from, __to, opt: copy_options::none);
76}
77inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to, error_code& __ec) {
78 return __copy_file(__from, __to, opt: copy_options::none, ec: &__ec);
79}
80inline _LIBCPP_HIDE_FROM_ABI bool copy_file(const path& __from, const path& __to, copy_options __opt) {
81 return __copy_file(__from, __to, __opt);
82}
83inline _LIBCPP_HIDE_FROM_ABI bool
84copy_file(const path& __from, const path& __to, copy_options __opt, error_code& __ec) {
85 return __copy_file(__from, __to, __opt, ec: &__ec);
86}
87inline _LIBCPP_HIDE_FROM_ABI void copy_symlink(const path& __from, const path& __to) { __copy_symlink(existing_symlink: __from, new_symlink: __to); }
88inline _LIBCPP_HIDE_FROM_ABI void copy_symlink(const path& __from, const path& __to, error_code& __ec) noexcept {
89 __copy_symlink(existing_symlink: __from, new_symlink: __to, ec: &__ec);
90}
91inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to) {
92 __copy(__from, __to, opt: copy_options::none);
93}
94inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, error_code& __ec) {
95 __copy(__from, __to, opt: copy_options::none, ec: &__ec);
96}
97inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, copy_options __opt) {
98 __copy(__from, __to, __opt);
99}
100inline _LIBCPP_HIDE_FROM_ABI void copy(const path& __from, const path& __to, copy_options __opt, error_code& __ec) {
101 __copy(__from, __to, __opt, ec: &__ec);
102}
103inline _LIBCPP_HIDE_FROM_ABI bool create_directories(const path& __p) { return __create_directories(__p); }
104inline _LIBCPP_HIDE_FROM_ABI bool create_directories(const path& __p, error_code& __ec) {
105 return __create_directories(__p, &__ec);
106}
107inline _LIBCPP_HIDE_FROM_ABI void create_directory_symlink(const path& __target, const path& __link) {
108 __create_directory_symlink(to: __target, new_symlink: __link);
109}
110inline _LIBCPP_HIDE_FROM_ABI void
111create_directory_symlink(const path& __target, const path& __link, error_code& __ec) noexcept {
112 __create_directory_symlink(to: __target, new_symlink: __link, ec: &__ec);
113}
114inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p) { return __create_directory(__p); }
115inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, error_code& __ec) noexcept {
116 return __create_directory(__p, &__ec);
117}
118inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, const path& __attrs) {
119 return __create_directory(__p, attributes: __attrs);
120}
121inline _LIBCPP_HIDE_FROM_ABI bool create_directory(const path& __p, const path& __attrs, error_code& __ec) noexcept {
122 return __create_directory(__p, attributes: __attrs, &__ec);
123}
124inline _LIBCPP_HIDE_FROM_ABI void create_hard_link(const path& __target, const path& __link) {
125 __create_hard_link(to: __target, new_hard_link: __link);
126}
127inline _LIBCPP_HIDE_FROM_ABI void
128create_hard_link(const path& __target, const path& __link, error_code& __ec) noexcept {
129 __create_hard_link(to: __target, new_hard_link: __link, ec: &__ec);
130}
131inline _LIBCPP_HIDE_FROM_ABI void create_symlink(const path& __target, const path& __link) {
132 __create_symlink(to: __target, new_symlink: __link);
133}
134inline _LIBCPP_HIDE_FROM_ABI void create_symlink(const path& __target, const path& __link, error_code& __ec) noexcept {
135 return __create_symlink(to: __target, new_symlink: __link, ec: &__ec);
136}
137inline _LIBCPP_HIDE_FROM_ABI path current_path() { return __current_path(); }
138inline _LIBCPP_HIDE_FROM_ABI path current_path(error_code& __ec) { return __current_path(ec: &__ec); }
139inline _LIBCPP_HIDE_FROM_ABI void current_path(const path& __p) { __current_path(__p); }
140inline _LIBCPP_HIDE_FROM_ABI void current_path(const path& __p, error_code& __ec) noexcept {
141 __current_path(__p, ec: &__ec);
142}
143inline _LIBCPP_HIDE_FROM_ABI bool equivalent(const path& __p1, const path& __p2) { return __equivalent(__p1, __p2); }
144inline _LIBCPP_HIDE_FROM_ABI bool equivalent(const path& __p1, const path& __p2, error_code& __ec) noexcept {
145 return __equivalent(__p1, __p2, ec: &__ec);
146}
147inline _LIBCPP_HIDE_FROM_ABI bool status_known(file_status __s) noexcept { return __s.type() != file_type::none; }
148inline _LIBCPP_HIDE_FROM_ABI bool exists(file_status __s) noexcept {
149 return status_known(__s) && __s.type() != file_type::not_found;
150}
151inline _LIBCPP_HIDE_FROM_ABI bool exists(const path& __p) { return exists(s: __status(__p)); }
152
153inline _LIBCPP_HIDE_FROM_ABI bool exists(const path& __p, error_code& __ec) noexcept {
154 auto __s = __status(__p, ec: &__ec);
155 if (status_known(__s))
156 __ec.clear();
157 return exists(__s);
158}
159
160inline _LIBCPP_HIDE_FROM_ABI uintmax_t file_size(const path& __p) { return __file_size(__p); }
161inline _LIBCPP_HIDE_FROM_ABI uintmax_t file_size(const path& __p, error_code& __ec) noexcept {
162 return __file_size(__p, ec: &__ec);
163}
164inline _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count(const path& __p) { return __hard_link_count(__p); }
165inline _LIBCPP_HIDE_FROM_ABI uintmax_t hard_link_count(const path& __p, error_code& __ec) noexcept {
166 return __hard_link_count(__p, ec: &__ec);
167}
168inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(file_status __s) noexcept { return __s.type() == file_type::block; }
169inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(const path& __p) { return is_block_file(s: __status(__p)); }
170inline _LIBCPP_HIDE_FROM_ABI bool is_block_file(const path& __p, error_code& __ec) noexcept {
171 return is_block_file(s: __status(__p, ec: &__ec));
172}
173inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(file_status __s) noexcept {
174 return __s.type() == file_type::character;
175}
176inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(const path& __p) { return is_character_file(s: __status(__p)); }
177inline _LIBCPP_HIDE_FROM_ABI bool is_character_file(const path& __p, error_code& __ec) noexcept {
178 return is_character_file(s: __status(__p, ec: &__ec));
179}
180inline _LIBCPP_HIDE_FROM_ABI bool is_directory(file_status __s) noexcept { return __s.type() == file_type::directory; }
181inline _LIBCPP_HIDE_FROM_ABI bool is_directory(const path& __p) { return is_directory(s: __status(__p)); }
182inline _LIBCPP_HIDE_FROM_ABI bool is_directory(const path& __p, error_code& __ec) noexcept {
183 return is_directory(s: __status(__p, ec: &__ec));
184}
185_LIBCPP_EXPORTED_FROM_ABI bool __fs_is_empty(const path& __p, error_code* __ec = nullptr);
186inline _LIBCPP_HIDE_FROM_ABI bool is_empty(const path& __p) { return __fs_is_empty(__p); }
187inline _LIBCPP_HIDE_FROM_ABI bool is_empty(const path& __p, error_code& __ec) { return __fs_is_empty(__p, ec: &__ec); }
188inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(file_status __s) noexcept { return __s.type() == file_type::fifo; }
189inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(const path& __p) { return is_fifo(s: __status(__p)); }
190inline _LIBCPP_HIDE_FROM_ABI bool is_fifo(const path& __p, error_code& __ec) noexcept {
191 return is_fifo(s: __status(__p, ec: &__ec));
192}
193inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(file_status __s) noexcept { return __s.type() == file_type::regular; }
194inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(const path& __p) { return is_regular_file(s: __status(__p)); }
195inline _LIBCPP_HIDE_FROM_ABI bool is_regular_file(const path& __p, error_code& __ec) noexcept {
196 return is_regular_file(s: __status(__p, ec: &__ec));
197}
198inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(file_status __s) noexcept { return __s.type() == file_type::symlink; }
199inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(const path& __p) { return is_symlink(s: __symlink_status(__p)); }
200inline _LIBCPP_HIDE_FROM_ABI bool is_symlink(const path& __p, error_code& __ec) noexcept {
201 return is_symlink(s: __symlink_status(__p, ec: &__ec));
202}
203inline _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}
206inline _LIBCPP_HIDE_FROM_ABI bool is_other(const path& __p) { return is_other(s: __status(__p)); }
207inline _LIBCPP_HIDE_FROM_ABI bool is_other(const path& __p, error_code& __ec) noexcept {
208 return is_other(s: __status(__p, ec: &__ec));
209}
210inline _LIBCPP_HIDE_FROM_ABI bool is_socket(file_status __s) noexcept { return __s.type() == file_type::socket; }
211inline _LIBCPP_HIDE_FROM_ABI bool is_socket(const path& __p) { return is_socket(s: __status(__p)); }
212inline _LIBCPP_HIDE_FROM_ABI bool is_socket(const path& __p, error_code& __ec) noexcept {
213 return is_socket(s: __status(__p, ec: &__ec));
214}
215inline _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time(const path& __p) { return __last_write_time(__p); }
216inline _LIBCPP_HIDE_FROM_ABI file_time_type last_write_time(const path& __p, error_code& __ec) noexcept {
217 return __last_write_time(__p, ec: &__ec);
218}
219inline _LIBCPP_HIDE_FROM_ABI void last_write_time(const path& __p, file_time_type __t) { __last_write_time(__p, new_time: __t); }
220inline _LIBCPP_HIDE_FROM_ABI void last_write_time(const path& __p, file_time_type __t, error_code& __ec) noexcept {
221 __last_write_time(__p, new_time: __t, ec: &__ec);
222}
223_LIBCPP_EXPORTED_FROM_ABI void __permissions(const path&, perms, perm_options, error_code* = nullptr);
224inline _LIBCPP_HIDE_FROM_ABI void
225permissions(const path& __p, perms __prms, perm_options __opts = perm_options::replace) {
226 __permissions(__p, __prms, __opts);
227}
228inline _LIBCPP_HIDE_FROM_ABI void permissions(const path& __p, perms __prms, error_code& __ec) noexcept {
229 __permissions(__p, __prms, perm_options::replace, &__ec);
230}
231inline _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
235inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, const path& __base, error_code& __ec) {
236 path __tmp = __weakly_canonical(__p, ec: &__ec);
237 if (__ec)
238 return {};
239 path __tmp_base = __weakly_canonical(p: __base, ec: &__ec);
240 if (__ec)
241 return {};
242 return __tmp.lexically_proximate(base: __tmp_base);
243}
244
245inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, error_code& __ec) {
246 return proximate(__p, base: current_path(), __ec);
247}
248inline _LIBCPP_HIDE_FROM_ABI path proximate(const path& __p, const path& __base = current_path()) {
249 return __weakly_canonical(__p).lexically_proximate(base: __weakly_canonical(p: __base));
250}
251inline _LIBCPP_HIDE_FROM_ABI path read_symlink(const path& __p) { return __read_symlink(__p); }
252inline _LIBCPP_HIDE_FROM_ABI path read_symlink(const path& __p, error_code& __ec) { return __read_symlink(__p, ec: &__ec); }
253
254inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, const path& __base, error_code& __ec) {
255 path __tmp = __weakly_canonical(__p, ec: &__ec);
256 if (__ec)
257 return path();
258 path __tmpbase = __weakly_canonical(p: __base, ec: &__ec);
259 if (__ec)
260 return path();
261 return __tmp.lexically_relative(base: __tmpbase);
262}
263
264inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, error_code& __ec) {
265 return relative(__p, base: current_path(), __ec);
266}
267inline _LIBCPP_HIDE_FROM_ABI path relative(const path& __p, const path& __base = current_path()) {
268 return __weakly_canonical(__p).lexically_relative(base: __weakly_canonical(p: __base));
269}
270inline _LIBCPP_HIDE_FROM_ABI uintmax_t remove_all(const path& __p) { return __remove_all(__p); }
271inline _LIBCPP_HIDE_FROM_ABI uintmax_t remove_all(const path& __p, error_code& __ec) {
272 return __remove_all(__p, ec: &__ec);
273}
274inline _LIBCPP_HIDE_FROM_ABI bool remove(const path& __p) { return __remove(__p); }
275inline _LIBCPP_HIDE_FROM_ABI bool remove(const path& __p, error_code& __ec) noexcept { return __remove(__p, ec: &__ec); }
276inline _LIBCPP_HIDE_FROM_ABI void rename(const path& __from, const path& __to) { return __rename(__from, __to); }
277inline _LIBCPP_HIDE_FROM_ABI void rename(const path& __from, const path& __to, error_code& __ec) noexcept {
278 return __rename(__from, __to, ec: &__ec);
279}
280inline _LIBCPP_HIDE_FROM_ABI void resize_file(const path& __p, uintmax_t __ns) { return __resize_file(__p, size: __ns); }
281inline _LIBCPP_HIDE_FROM_ABI void resize_file(const path& __p, uintmax_t __ns, error_code& __ec) noexcept {
282 return __resize_file(__p, size: __ns, &__ec);
283}
284_LIBCPP_EXPORTED_FROM_ABI space_info __space(const path&, error_code* __ec = nullptr);
285inline _LIBCPP_HIDE_FROM_ABI space_info space(const path& __p) { return __space(__p); }
286inline _LIBCPP_HIDE_FROM_ABI space_info space(const path& __p, error_code& __ec) noexcept {
287 return __space(__p, ec: &__ec);
288}
289inline _LIBCPP_HIDE_FROM_ABI file_status status(const path& __p) { return __status(__p); }
290inline _LIBCPP_HIDE_FROM_ABI file_status status(const path& __p, error_code& __ec) noexcept {
291 return __status(__p, ec: &__ec);
292}
293inline _LIBCPP_HIDE_FROM_ABI file_status symlink_status(const path& __p) { return __symlink_status(__p); }
294inline _LIBCPP_HIDE_FROM_ABI file_status symlink_status(const path& __p, error_code& __ec) noexcept {
295 return __symlink_status(__p, ec: &__ec);
296}
297inline _LIBCPP_HIDE_FROM_ABI path temp_directory_path() { return __temp_directory_path(); }
298inline _LIBCPP_HIDE_FROM_ABI path temp_directory_path(error_code& __ec) { return __temp_directory_path(ec: &__ec); }
299inline _LIBCPP_HIDE_FROM_ABI path weakly_canonical(path const& __p) { return __weakly_canonical(__p); }
300inline _LIBCPP_HIDE_FROM_ABI path weakly_canonical(path const& __p, error_code& __ec) {
301 return __weakly_canonical(__p, ec: &__ec);
302}
303
304_LIBCPP_AVAILABILITY_FILESYSTEM_LIBRARY_POP
305
306_LIBCPP_END_NAMESPACE_FILESYSTEM
307
308#endif // _LIBCPP_STD_VER >= 17 && !defined(_LIBCPP_HAS_NO_FILESYSTEM)
309
310#endif // _LIBCPP___FILESYSTEM_OPERATIONS_H
311