summaryrefslogtreecommitdiff
path: root/src/common/file_util.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/file_util.h')
-rw-r--r--src/common/file_util.h63
1 files changed, 32 insertions, 31 deletions
diff --git a/src/common/file_util.h b/src/common/file_util.h
index 5bc7fbf7c..9bb3c4109 100644
--- a/src/common/file_util.h
+++ b/src/common/file_util.h
@@ -150,6 +150,31 @@ size_t ReadFileToString(bool text_file, const char* filename, std::string& str);
150void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name, 150void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name,
151 std::array<char, 4>& extension); 151 std::array<char, 4>& extension);
152 152
153// Splits the path on '/' or '\' and put the components into a vector
154// i.e. "C:\Users\Yuzu\Documents\save.bin" becomes {"C:", "Users", "Yuzu", "Documents", "save.bin" }
155std::vector<std::string> SplitPathComponents(const std::string& filename);
156
157// Gets all of the text prior to the last '/' or '\' in the path.
158std::string GetParentPath(const std::string& path);
159
160// Gets the filename of the path
161std::string GetFilename(std::string path);
162
163// Gets the extension of the filename
164std::string GetExtensionFromFilename(const std::string& name);
165
166// Removes the final '/' or '\' if one exists
167std::string RemoveTrailingSlash(const std::string& path);
168
169// Creates a new vector containing indices [first, last) from the original.
170template <typename T>
171std::vector<T> SliceVector(const std::vector<T>& vector, size_t first, size_t last) {
172 if (first >= last)
173 return {};
174 last = std::min<size_t>(last, vector.size());
175 return std::vector<T>(vector.begin() + first, vector.begin() + first + last);
176}
177
153// simple wrapper for cstdlib file functions to 178// simple wrapper for cstdlib file functions to
154// hopefully will make error checking easier 179// hopefully will make error checking easier
155// and make forgetting an fclose() harder 180// and make forgetting an fclose() harder
@@ -172,41 +197,27 @@ public:
172 bool Close(); 197 bool Close();
173 198
174 template <typename T> 199 template <typename T>
175 size_t ReadArray(T* data, size_t length) { 200 size_t ReadArray(T* data, size_t length) const {
176 static_assert(std::is_trivially_copyable<T>(), 201 static_assert(std::is_trivially_copyable<T>(),
177 "Given array does not consist of trivially copyable objects"); 202 "Given array does not consist of trivially copyable objects");
178 203
179 if (!IsOpen()) { 204 if (!IsOpen())
180 m_good = false;
181 return -1; 205 return -1;
182 }
183 206
184 size_t items_read = std::fread(data, sizeof(T), length, m_file); 207 return std::fread(data, sizeof(T), length, m_file);
185 if (items_read != length)
186 m_good = false;
187
188 return items_read;
189 } 208 }
190 209
191 template <typename T> 210 template <typename T>
192 size_t WriteArray(const T* data, size_t length) { 211 size_t WriteArray(const T* data, size_t length) {
193 static_assert(std::is_trivially_copyable<T>(), 212 static_assert(std::is_trivially_copyable<T>(),
194 "Given array does not consist of trivially copyable objects"); 213 "Given array does not consist of trivially copyable objects");
195 214 if (!IsOpen())
196 if (!IsOpen()) {
197 m_good = false;
198 return -1; 215 return -1;
199 } 216 return std::fwrite(data, sizeof(T), length, m_file);
200
201 size_t items_written = std::fwrite(data, sizeof(T), length, m_file);
202 if (items_written != length)
203 m_good = false;
204
205 return items_written;
206 } 217 }
207 218
208 template <typename T> 219 template <typename T>
209 size_t ReadBytes(T* data, size_t length) { 220 size_t ReadBytes(T* data, size_t length) const {
210 static_assert(std::is_trivially_copyable<T>(), "T must be trivially copyable"); 221 static_assert(std::is_trivially_copyable<T>(), "T must be trivially copyable");
211 return ReadArray(reinterpret_cast<char*>(data), length); 222 return ReadArray(reinterpret_cast<char*>(data), length);
212 } 223 }
@@ -231,15 +242,7 @@ public:
231 return nullptr != m_file; 242 return nullptr != m_file;
232 } 243 }
233 244
234 // m_good is set to false when a read, write or other function fails 245 bool Seek(s64 off, int origin) const;
235 bool IsGood() const {
236 return m_good;
237 }
238 explicit operator bool() const {
239 return IsGood();
240 }
241
242 bool Seek(s64 off, int origin);
243 u64 Tell() const; 246 u64 Tell() const;
244 u64 GetSize() const; 247 u64 GetSize() const;
245 bool Resize(u64 size); 248 bool Resize(u64 size);
@@ -247,13 +250,11 @@ public:
247 250
248 // clear error state 251 // clear error state
249 void Clear() { 252 void Clear() {
250 m_good = true;
251 std::clearerr(m_file); 253 std::clearerr(m_file);
252 } 254 }
253 255
254private: 256private:
255 std::FILE* m_file = nullptr; 257 std::FILE* m_file = nullptr;
256 bool m_good = true;
257}; 258};
258 259
259} // namespace FileUtil 260} // namespace FileUtil