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