1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje
#pragma once
#include <io/Folder.h>
#include <utility/TypeTraits.h>
#include <string_view>
#include <iosfwd>
namespace ausaxs::io {
class File {
public:
File() = default;
File(const File&) = default;
File(File&&) noexcept = default;
File &operator=(const File&) = default;
File &operator=(File&&) noexcept = default;
File(const io::Folder& folder, std::string_view name, std::string_view extension);
File(std::string_view name, std::string_view extension);
template<ausaxs::detail::string_like T>
File(const T& path) : File(std::string_view(path)) {}
File(std::string_view path);
virtual ~File() = default;
/**
* @brief Get the path to this file relative to the current directory.
*/
[[nodiscard]] std::string path() const;
[[nodiscard]] std::string str() const; //< @copydoc path()
/**
* @brief Get the absolute path to this file.
*/
[[nodiscard]] std::string absolute_path() const;
/**
* @brief Get the relative path to another file with this as the base.
*/
[[nodiscard]] std::string relative_path(const File& other) const;
[[nodiscard]] operator std::string() const;
/**
* @brief Replace the extension of the file.
*/
File& replace_extension(std::string_view extension) noexcept;
/**
* @brief Append to the name of the file.
*/
File& append(std::string_view name) noexcept;
[[nodiscard]] File append(std::string_view name) const noexcept; //< @copydoc append()
/**
* @brief Get the filename.
* This is just the combined stem and extension of the file.
*/
[[nodiscard]] std::string filename() const noexcept;
/**
* @brief Get the stem of the file.
*/
[[nodiscard]] std::string& stem() noexcept;
[[nodiscard]] std::string stem() const noexcept; //< @copydoc stem()
/**
* @brief Get the directory of the file.
*/
[[nodiscard]] Folder& directory() noexcept;
[[nodiscard]] const Folder& directory() const noexcept; //< @copydoc directory()
/**
* @brief Get the extension of the file, including the dot.
*/
[[nodiscard]] std::string& extension() noexcept;
[[nodiscard]] const std::string& extension() const noexcept; //< @copydoc extension()
/**
* @brief Check if this object is initialized.
*/
[[nodiscard]] bool empty() const noexcept;
/**
* @brief Create this file on disk with the given contents.
* Parent directories are created if they do not already exist.
* If the file already exists, it is overwritten.
*/
void create(std::string_view contents = "") const;
/**
* @brief Delete this file from disk.
*/
void remove() const;
/**
* @brief Move this file to the given folder.
* The destination folder is created if it does not already exist.
*
* @returns The path to the new file.
*/
io::File move(const io::Folder& folder) const;
/**
* @brief Copy this file to the given folder.
* The destination folder is created if it does not already exist.
*
* @returns The path to the new file.
*/
io::File copy(const io::Folder& folder) const;
/**
* @brief Rename this file on disk.
*
* @returns The path to the new file.
*/
io::File rename(std::string_view name) const;
/**
* @brief Check if the file exists.
*/
[[nodiscard]] bool exists() const noexcept;
/**
* @brief Split a path into a directory, filename and extension.
*/
static std::tuple<std::string, std::string, std::string> split(std::string_view path);
private:
Folder dir;
std::string name;
std::string ext;
};
static_assert(supports_nothrow_move_v<File>, "File should support nothrow move semantics.");
}
std::ostream& operator<<(std::ostream& os, const ausaxs::io::File& file);
|
