Filesystem.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_FILESYSTEM_HPP
#define TGUI_FILESYSTEM_HPP
 
#include <TGUI/String.hpp>
 
#include <cstdint>
#include <vector>
#include <ctime>
 
#ifdef TGUI_USE_STD_FILESYSTEM
    #include <filesystem>
#endif

 
namespace tgui
{
    class TGUI_API Filesystem
    {
    public:

        class TGUI_API Path
        {
        public:

            Path() = default;

            explicit Path(const String& path);
 
#ifdef TGUI_USE_STD_FILESYSTEM
            template <typename PathType, std::enable_if_t<std::is_same_v<PathType, std::filesystem::path>, int> = 0>
            explicit Path(const PathType& path) :
                m_path(path)
            {
            }
#endif

            TGUI_NODISCARD bool isEmpty() const;

            TGUI_NODISCARD bool isAbsolute() const;

            TGUI_NODISCARD bool isRelative() const;

            TGUI_NODISCARD String asString() const;

            TGUI_NODISCARD Path getParentPath() const;

            TGUI_NODISCARD String getFilename() const;

            TGUI_NODISCARD Path getNormalForm() const;

#ifdef TGUI_SYSTEM_WINDOWS
            TGUI_NODISCARD std::wstring asNativeString() const;
#else
            TGUI_NODISCARD std::string asNativeString() const;
#endif
 
#ifdef TGUI_USE_STD_FILESYSTEM
            operator const std::filesystem::path&() const
            {
                return m_path;
            }
#endif

            TGUI_NODISCARD Path operator/(const Path& path) const;

            TGUI_NODISCARD Path operator/(const String& path) const
            {
                return *this / Path(path);
            }

            Path& operator/=(const Path& path);

            Path& operator/=(const String& path)
            {
                return *this /= Path(path);
            }

            TGUI_NODISCARD bool operator==(const Path& other) const;

            TGUI_NODISCARD bool operator!=(const Path& other) const;

        private:
 
#ifdef TGUI_USE_STD_FILESYSTEM
            std::filesystem::path m_path;
#else
            std::vector<String> m_parts;
            String m_root; // Drive letter or empty
            bool m_absolute = false;
#endif
        };

        struct TGUI_API FileInfo
        {
            String filename;
            Path path;
            bool directory = false; // Is it a regular file or a folder?
            std::uintmax_t fileSize = 0;
            std::time_t modificationTime = 0;
        };

        TGUI_NODISCARD static bool directoryExists(const Path& path);

        TGUI_NODISCARD static bool directoryExists(const String& path)
        {
            return directoryExists(Path{path});
        }

        TGUI_NODISCARD static bool fileExists(const Path& path);

        TGUI_NODISCARD static bool fileExists(const String& path)
        {
            return fileExists(Path{path});
        }

        static bool createDirectory(const Path& path);

        static bool createDirectory(const String& path)
        {
            return createDirectory(Path{path});
        }

        TGUI_NODISCARD static Path getHomeDirectory();

        TGUI_NODISCARD static Path getCurrentWorkingDirectory();

        TGUI_NODISCARD static Path getLocalDataDirectory();

        TGUI_NODISCARD static std::vector<FileInfo> listFilesInDirectory(const Path& path);
    };

}

 
#endif // TGUI_FILESYSTEM_HPP