xref: /freebsd/contrib/kyua/utils/fs/operations.hpp (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/fs/operations.hpp
30 /// File system algorithms and access functions.
31 ///
32 /// The functions in this module are exception-based, type-improved wrappers
33 /// over the functions provided by libc.
34 
35 #if !defined(UTILS_FS_OPERATIONS_HPP)
36 #define UTILS_FS_OPERATIONS_HPP
37 
38 #include <set>
39 #include <string>
40 
41 #include "utils/fs/directory_fwd.hpp"
42 #include "utils/fs/path_fwd.hpp"
43 #include "utils/optional_fwd.hpp"
44 #include "utils/units_fwd.hpp"
45 
46 namespace utils {
47 namespace fs {
48 
49 
50 void copy(const fs::path&, const fs::path&);
51 path current_path(void);
52 bool exists(const fs::path&);
53 utils::optional< path > find_in_path(const char*);
54 utils::units::bytes free_disk_space(const fs::path&);
55 bool is_directory(const fs::path&);
56 void mkdir(const path&, const int);
57 void mkdir_p(const path&, const int);
58 fs::path mkdtemp_public(const std::string&);
59 fs::path mkstemp(const std::string&);
60 void mount_tmpfs(const path&);
61 void mount_tmpfs(const path&, const units::bytes&);
62 void rm_r(const path&);
63 void rmdir(const path&);
64 std::set< directory_entry > scan_directory(const path&);
65 void unlink(const path&);
66 void unmount(const path&);
67 
68 
69 }  // namespace fs
70 }  // namespace utils
71 
72 #endif  // !defined(UTILS_FS_OPERATIONS_HPP)
73