TGUI  1.5
Loading...
Searching...
No Matches
Filesystem.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef TGUI_FILESYSTEM_HPP
26#define TGUI_FILESYSTEM_HPP
27
28#include <TGUI/String.hpp>
29
30#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
31 #include <cstdint>
32 #include <vector>
33 #include <ctime>
34
35 #ifdef TGUI_USE_STD_FILESYSTEM
36 #include <filesystem>
37 #endif
38#endif
39
41
42TGUI_MODULE_EXPORT namespace tgui
43{
50 class TGUI_API Filesystem
51 {
52 public:
53
57 class TGUI_API Path
58 {
59 public:
60
64 Path() = default;
65
71 explicit Path(const String& path);
72
73#ifdef TGUI_USE_STD_FILESYSTEM
81 template <typename PathType, std::enable_if_t<std::is_same_v<PathType, std::filesystem::path>, int> = 0>
82 explicit Path(const PathType& path) :
83 m_path(path)
84 {
85 }
86#endif
87
93 TGUI_NODISCARD bool isEmpty() const;
94
103 TGUI_NODISCARD bool isAbsolute() const;
104
113 TGUI_NODISCARD bool isRelative() const;
114
122 TGUI_NODISCARD String asString() const;
123
131 TGUI_NODISCARD Path getParentPath() const;
132
138 TGUI_NODISCARD String getFilename() const;
139
145 TGUI_NODISCARD Path getNormalForm() const;
146
155#ifdef TGUI_SYSTEM_WINDOWS
156 TGUI_NODISCARD std::wstring asNativeString() const;
157#else
158 TGUI_NODISCARD std::string asNativeString() const;
159#endif
160
161#ifdef TGUI_USE_STD_FILESYSTEM
165 operator const std::filesystem::path&() const
166 {
167 return m_path;
168 }
169#endif
170
178 TGUI_NODISCARD Path operator/(const Path& path) const;
179
187 TGUI_NODISCARD Path operator/(const String& path) const
188 {
189 return *this / Path(path);
190 }
191
199 Path& operator/=(const Path& path);
200
208 Path& operator/=(const String& path)
209 {
210 return *this /= Path(path);
211 }
212
220 TGUI_NODISCARD bool operator==(const Path& other) const;
221
229 TGUI_NODISCARD bool operator!=(const Path& other) const;
230
232 private:
233
234#ifdef TGUI_USE_STD_FILESYSTEM
235 std::filesystem::path m_path;
236#else
237 std::vector<String> m_parts;
238 String m_root; // Drive letter or empty
239 bool m_absolute = false;
240#endif
241 };
242
246 struct TGUI_API FileInfo
247 {
248 String filename;
249 Path path;
250 bool directory = false; // Is it a regular file or a folder?
251 std::uintmax_t fileSize = 0;
252 std::time_t modificationTime = 0;
253 };
254
262 TGUI_NODISCARD static bool directoryExists(const Path& path);
263
271 TGUI_NODISCARD static bool directoryExists(const String& path)
272 {
273 return directoryExists(Path{path});
274 }
275
283 TGUI_NODISCARD static bool fileExists(const Path& path);
284
292 TGUI_NODISCARD static bool fileExists(const String& path)
293 {
294 return fileExists(Path{path});
295 }
296
306 static bool createDirectory(const Path& path);
307
317 static bool createDirectory(const String& path)
318 {
319 return createDirectory(Path{path});
320 }
321
327 TGUI_NODISCARD static Path getHomeDirectory();
328
334 TGUI_NODISCARD static Path getCurrentWorkingDirectory();
335
345 TGUI_NODISCARD static Path getLocalDataDirectory();
346
354 TGUI_NODISCARD static std::vector<FileInfo> listFilesInDirectory(const Path& path);
355 };
356
358}
359
361
362#endif // TGUI_FILESYSTEM_HPP
Object to represent paths on a filesystem.
Definition Filesystem.hpp:58
TGUI_NODISCARD std::string asNativeString() const
Returns the path as a string, but with a string type and contents that depends on the OS.
TGUI_NODISCARD bool operator!=(const Path &other) const
Checks whether the paths are not equal.
TGUI_NODISCARD bool isAbsolute() const
Checks whether the path is absolute.
Path()=default
Default constructor that creates an empty path object.
TGUI_NODISCARD bool operator==(const Path &other) const
Checks whether the paths are equal.
TGUI_NODISCARD bool isEmpty() const
Check if this object is empty.
Path & operator/=(const Path &path)
Joins this object with another path.
Path & operator/=(const String &path)
Joins this object with another path.
Definition Filesystem.hpp:208
Path(const String &path)
Constructor that creates a Path object from the given path string.
TGUI_NODISCARD Path operator/(const String &path) const
Returns a new path that consists of this object joined with another path.
Definition Filesystem.hpp:187
TGUI_NODISCARD Path getParentPath() const
Returns to path to the parent directory.
TGUI_NODISCARD String asString() const
Returns the path as a string.
TGUI_NODISCARD Path getNormalForm() const
Returns the lexically normal form of the path (path with '.' and '..' resolved)
TGUI_NODISCARD bool isRelative() const
Checks whether the path is relative.
TGUI_NODISCARD Path operator/(const Path &path) const
Returns a new path that consists of this object joined with another path.
TGUI_NODISCARD String getFilename() const
Returns to filename component of the path (where the path consists of getParentPath() / getFilename()...
Helper functionality for filesystem access.
Definition Filesystem.hpp:51
static TGUI_NODISCARD std::vector< FileInfo > listFilesInDirectory(const Path &path)
Returns a list of all files and folders inside a given directory.
static TGUI_NODISCARD Path getLocalDataDirectory()
Returns the directory to store application data.
static TGUI_NODISCARD bool fileExists(const String &path)
Checks if a file exists.
Definition Filesystem.hpp:292
static bool createDirectory(const Path &path)
Create a directory.
static TGUI_NODISCARD bool fileExists(const Path &path)
Checks if a file exists.
static TGUI_NODISCARD Path getHomeDirectory()
Returns the home directory.
static TGUI_NODISCARD bool directoryExists(const Path &path)
Checks if a directory exists.
static bool createDirectory(const String &path)
Create a directory.
Definition Filesystem.hpp:317
static TGUI_NODISCARD Path getCurrentWorkingDirectory()
Returns the current working directory.
static TGUI_NODISCARD bool directoryExists(const String &path)
Checks if a directory exists.
Definition Filesystem.hpp:271
Wrapper class to store strings.
Definition String.hpp:96
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
Information about a file or directory, used to return data from the listFilesInDirectory function.
Definition Filesystem.hpp:247