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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* libfud
* Copyright 2024 Dominick Allen
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FUD_C_FILE_HPP
#define FUD_C_FILE_HPP
#include "fud_result.hpp"
#include "fud_string.hpp"
#include <cstdint>
#include <cstdio>
namespace fud {
/** \brief Access Modes for */
enum class CFileMode : uint8_t
{
ReadOnly,
ReadWrite,
WriteTruncate,
ReadWriteTruncate,
WriteAppend,
ReadWriteAppend,
};
constexpr const char* CBinaryFileModeFromFlags(CFileMode mode)
{
switch (mode) {
case CFileMode::ReadOnly:
return "rb";
case CFileMode::ReadWrite:
return "r+b";
case CFileMode::WriteTruncate:
return "wb";
case CFileMode::ReadWriteTruncate:
return "w+b";
case CFileMode::WriteAppend:
return "ab";
case CFileMode::ReadWriteAppend:
return "a+b";
default:
return "";
}
}
constexpr const char* CTextFileModeFromFlags(CFileMode mode)
{
switch (mode) {
case CFileMode::ReadOnly:
return "r";
case CFileMode::ReadWrite:
return "r+";
case CFileMode::WriteTruncate:
return "w";
case CFileMode::ReadWriteTruncate:
return "w+";
case CFileMode::WriteAppend:
return "a";
case CFileMode::ReadWriteAppend:
return "a+";
default:
return "";
}
}
enum class FileStatus
{
Success,
PartialSuccess,
InvalidName,
InvalidArgument,
InvalidState,
NullPointer,
Error,
};
static inline const char* FileStatusToString(FileStatus status)
{
switch (status) {
case FileStatus::Success:
return "Success";
case FileStatus::PartialSuccess:
return "PartialSuccess";
case FileStatus::InvalidName:
return "InvalidName";
case FileStatus::InvalidArgument:
return "InvalidArgument";
case FileStatus::InvalidState:
return "InvalidState";
case FileStatus::NullPointer:
return "NullPointer";
case FileStatus::Error:
return "Error";
default:
return "Unknown";
}
}
struct [[nodiscard]] ReadResult {
size_t bytesRead{0};
FileStatus status{FileStatus::Success};
};
struct [[nodiscard]] WriteResult {
size_t bytesWritten{0};
FileStatus status{FileStatus::Success};
};
class CBinaryFile {
public:
CBinaryFile(const String& filename, CFileMode mode);
CBinaryFile(const String& filename, CFileMode mode, const String& extraFlags);
CBinaryFile(const CBinaryFile& rhs) = delete;
~CBinaryFile();
CBinaryFile& operator=(const CBinaryFile& rhs) = delete;
FileStatus open();
void close();
const FILE* file() const;
[[nodiscard]] FILE* file();
[[nodiscard]] bool isOpen() const;
[[nodiscard]] Result<size_t, FileStatus> size() const;
[[nodiscard]] ReadResult read(void* destination, size_t destinationSize, size_t length);
[[nodiscard]] ReadResult read(void* destination, size_t destinationSize, size_t length, size_t offset);
template <typename T>
[[nodiscard]] ReadResult read(T& destination, size_t length)
{
return read(destination, length, 0);
}
template <typename T>
[[nodiscard]] ReadResult read(T& destination, size_t length, size_t offset)
{
return read(&destination, sizeof(destination), length, offset);
}
[[nodiscard]] WriteResult write(const void* source, size_t sourceSize, size_t length);
[[nodiscard]] WriteResult write(const void* source, size_t sourceSize, size_t length, size_t offset);
template <typename T>
[[nodiscard]] WriteResult write(const T& source)
{
return write(source, sizeof(source), sizeof(source));
}
template <typename T>
[[nodiscard]] WriteResult write(const T& source, size_t sourceSize, size_t length)
{
auto offsetResult = size();
if (offsetResult.isError()) {
return WriteResult{0, offsetResult.getError()};
}
return write(source, sourceSize, length, offsetResult.getOkay());
}
template <typename T>
[[nodiscard]] WriteResult write(const T& source, size_t sourceSize, size_t length, size_t offset)
{
return write(static_cast<const void*>(&source), sourceSize, length, offset);
}
private:
FileStatus reset() const;
const String m_filename;
String m_extraFlags{};
String m_mode;
CFileMode m_modeFlags;
FILE* m_file{nullptr};
};
} // namespace fud
#endif
|