Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
FileSystem.h
1// Copyright (c) Stefano Cristiano
2// SPDX-License-Identifier: MIT
3#pragma once
4#include "../Foundation/Internal/IGrowableBuffer.h"
5#include "../Foundation/Result.h"
6#include "../Foundation/StringPath.h"
7
8namespace SC
9{
12
15
18{
19 size_t fileSize = 0;
21};
22
25{
27 {
28 overwrite = false;
30 }
31
36 {
37 overwrite = value;
38 return *this;
39 }
40
45 {
46 useCloneIfSupported = value;
47 return *this;
48 }
49
50 bool overwrite;
52};
53
60struct SC_COMPILER_EXPORT FileSystem
61{
62 bool preciseErrorMessages = false;
63
67 Result init(StringSpan initialDirectory);
68
73
76
84
92
101 Result copyFile(StringSpan source, StringSpan destination, CopyFlags copyFlags = CopyFlags())
102 {
103 return copyFiles(CopyOperation{source, destination, copyFlags});
104 }
105
111
120 Result copyDirectory(StringSpan source, StringSpan destination, CopyFlags copyFlags = CopyFlags())
121 {
122 return copyDirectories(CopyOperation{source, destination, copyFlags});
123 }
124
134
139
144 Result removeFile(StringSpan source) { return removeFiles({source}); }
145
150
155
161
168 Result removeDirectoryRecursive(StringSpan directory) { return removeDirectoriesRecursive({directory}); }
169
175
180 Result removeEmptyDirectory(StringSpan directory) { return removeEmptyDirectories({directory}); }
181
187
192 Result makeDirectory(StringSpan directory) { return makeDirectories({directory}); }
193
198
202 Result makeDirectoryIfNotExists(StringSpan directory) { return makeDirectoriesIfNotExists({directory}); }
203
209
214 Result makeDirectoryRecursive(StringSpan directory) { return makeDirectoriesRecursive({directory}); }
215
220 Result createSymbolicLink(StringSpan sourceFileOrDirectory, StringSpan linkFile);
221
226 [[nodiscard]] bool exists(StringSpan fileOrDirectory);
227
231 [[nodiscard]] bool existsAndIsDirectory(StringSpan directory);
232
239 [[nodiscard]] bool existsAndIsFile(StringSpan file);
240
244 [[nodiscard]] bool existsAndIsLink(StringSpan file);
245
250 [[nodiscard]] bool moveDirectory(StringSpan sourceDirectory, StringSpan destinationDirectory);
251
260 Result write(StringSpan file, Span<const uint8_t> data);
261
268
274
280 template <typename T>
281 Result read(StringSpan file, T& data)
282 {
283 return read(file, GrowableBuffer<T>{data});
284 }
285
290 Result read(StringSpan file, IGrowableBuffer&& buffer);
291
294
300
306
309 struct SC_COMPILER_EXPORT Operations
310 {
311 static Result createSymbolicLink(StringSpan sourceFileOrDirectory, StringSpan linkFile);
312 static Result makeDirectory(StringSpan dir);
313 static Result exists(StringSpan path);
314 static Result existsAndIsDirectory(StringSpan path);
315 static Result existsAndIsFile(StringSpan path);
316 static Result existsAndIsLink(StringSpan path);
317 static Result makeDirectoryRecursive(StringSpan path);
318 static Result removeEmptyDirectory(StringSpan path);
319 static Result moveDirectory(StringSpan source, StringSpan destination);
320 static Result removeFile(StringSpan path);
321 static Result copyFile(StringSpan srcPath, StringSpan destPath, FileSystemCopyFlags flags);
322 static Result rename(StringSpan path, StringSpan newPath);
323 static Result copyDirectory(StringSpan srcPath, StringSpan destPath, FileSystemCopyFlags flags);
324 static Result removeDirectoryRecursive(StringSpan directory);
325 static Result getFileStat(StringSpan path, FileSystemStat& fileStat);
326 static Result setLastModifiedTime(StringSpan path, TimeMs time);
327
328 static StringSpan getExecutablePath(StringPath& executablePath);
329 static StringSpan getCurrentWorkingDirectory(StringPath& currentWorkingDirectory);
330 static StringSpan getApplicationRootDirectory(StringPath& applicationRootDirectory);
331
332 private:
333 struct Internal;
334 };
335
336 private:
337 [[nodiscard]] bool convert(const StringSpan file, StringPath& destination, StringSpan* encodedPath = nullptr);
338
339 StringPath fileFormatBuffer1;
340 StringPath fileFormatBuffer2;
341 StringPath currentDirectory;
342
343 char errorMessageBuffer[256] = {0};
344
345 Result formatError(int errorNumber, StringSpan item, bool isWindowsNativeError);
346 struct Internal;
347};
349} // namespace SC
A structure to describe copy flags.
Definition FileSystem.h:25
FileSystemCopyFlags & setUseCloneIfSupported(bool value)
If true copy will use native filesystem clone os api.
Definition FileSystem.h:44
FileSystemCopyFlags & setOverwrite(bool value)
If true copy will overwrite existing files in the destination.
Definition FileSystem.h:35
bool useCloneIfSupported
If true copy will use native filesystem clone os api.
Definition FileSystem.h:51
bool overwrite
If true copy will overwrite existing files in the destination.
Definition FileSystem.h:50
A structure to describe file stats.
Definition FileSystem.h:18
size_t fileSize
Size of the file in bytes.
Definition FileSystem.h:19
TimeMs modifiedTime
Time when file was last modified.
Definition FileSystem.h:20
Specify source, destination and flags for a copy operation.
Definition FileSystem.h:79
StringSpan destination
Copy operation sink (can be a {relative | absolute} {file | directory} path)
Definition FileSystem.h:81
CopyFlags copyFlags
Copy operation flags (overwrite, use clone api etc.)
Definition FileSystem.h:82
StringSpan source
Copy operation source (can be a {relative | absolute} {file | directory} path)
Definition FileSystem.h:80
Low level filesystem API, requiring paths in native encoding (UTF-16 on Windows, UTF-8 elsewhere)
Definition FileSystem.h:310
Execute fs operations { exists, copy, delete } for { files and directories }.
Definition FileSystem.h:61
bool existsAndIsFile(StringSpan file)
Check if a file exists at given path.
Result removeFiles(Span< const StringSpan > files)
Remove multiple files.
Result removeFile(StringSpan source)
Remove a single file.
Definition FileSystem.h:144
Result init(StringSpan initialDirectory)
Call init function when instantiating the class to set directory for all operations using relative pa...
Result read(StringSpan file, T &data)
Read contents of a file into a String or Buffer.
Definition FileSystem.h:281
Result changeDirectory(StringSpan newDirectory)
Changes current directory.
Result makeDirectoriesRecursive(Span< const StringSpan > directories)
Create new directories, creating also intermediate non existing directories (like posix mkdir -p)
Result removeLinkIfExists(StringSpan source)
Remove a single link, giving no error if it doesn't exist.
bool exists(StringSpan fileOrDirectory)
Check if a file or directory exists at a given path.
bool moveDirectory(StringSpan sourceDirectory, StringSpan destinationDirectory)
Moves a directory from source to destination.
Result removeDirectoriesRecursive(Span< const StringSpan > directories)
Remove multiple directories with their entire content (like posix rm -rf)
Result setLastModifiedTime(StringSpan file, TimeMs time)
Change last modified time of a given file.
Result copyFiles(Span< const CopyOperation > sourceDestination)
Copies many files.
Result removeEmptyDirectories(Span< const StringSpan > directories)
Removes multiple empty directories.
Result makeDirectoryRecursive(StringSpan directory)
Create a new directory, creating also intermediate non existing directories (like posix mkdir -p)
Definition FileSystem.h:214
bool existsAndIsDirectory(StringSpan directory)
Check if a directory exists at given path.
Result writeStringAppend(StringSpan file, StringSpan text)
Appends a StringSpan to a file.
Result getFileStat(StringSpan file, FileStat &fileStat)
Obtains stats (size, modified time) about a file.
Result removeFileIfExists(StringSpan source)
Remove a single file, giving no error if it doesn't exist.
Result rename(StringSpan path, StringSpan newPath)
Rename a file or directory.
Result makeDirectory(StringSpan directory)
Creates a new directory that does not already exist.
Definition FileSystem.h:192
Result removeDirectoryRecursive(StringSpan directory)
Remove single directory with its entire content (like posix rm -rf)
Definition FileSystem.h:168
Result makeDirectories(Span< const StringSpan > directories)
Creates new directories that do not already exist.
Result write(StringSpan file, Span< const char > data)
Writes a block of memory to a file.
Result read(StringSpan file, IGrowableBuffer &&buffer)
Read contents of a file into an IGrowableBuffer.
Result makeDirectoriesIfNotExists(Span< const StringSpan > directories)
Creates new directories, if they don't already exist at the given path.
Result copyDirectory(StringSpan source, StringSpan destination, CopyFlags copyFlags=CopyFlags())
Copy a single directory.
Definition FileSystem.h:120
Result createSymbolicLink(StringSpan sourceFileOrDirectory, StringSpan linkFile)
Creates a symbolic link at location linkFile pointing at sourceFileOrDirectory.
Result copyDirectories(Span< const CopyOperation > sourceDestination)
Copy many directories.
Result copyFile(StringSpan source, StringSpan destination, CopyFlags copyFlags=CopyFlags())
Copy a single file.
Definition FileSystem.h:101
Result makeDirectoryIfNotExists(StringSpan directory)
Creates a new directory, if it doesn't already exists at the given path.
Definition FileSystem.h:202
Result removeEmptyDirectory(StringSpan directory)
Removes an empty directory.
Definition FileSystem.h:180
bool existsAndIsLink(StringSpan file)
Check if a link exists at given path.
Result writeString(StringSpan file, StringSpan text)
Replace the entire content of a file with the provided StringSpan.
An ascii string used as boolean result. SC_TRY macro forwards errors to caller.
Definition Result.h:12
View over a contiguous sequence of items (pointer + size in elements).
Definition Span.h:29
Pre-sized char array holding enough space to represent a file system path.
Definition StringPath.h:42
An read-only view over a string (to avoid including Strings library when parsing is not needed).
Definition StringSpan.h:37
A vocabulary type representing a time interval in milliseconds since epoch.
Definition PrimitiveTypes.h:63