lfilesystem_FilesystemEntry.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <cstdint>     // for uintmax_t
#include <filesystem>  // for copy_options, path, perm_options
#include <string>      // for string
#include <functional>  // for std::hash
#include <optional>
#include <ostream>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_Permissions.h"
 
namespace limes::files
{
 
class Directory;
class File;
class SymLink;
class Volume;
 
using Path = std::filesystem::path;
 
class LFILE_EXPORT FilesystemEntry
{
public:
 
    using PermOptions = std::filesystem::perm_options;
 
    using CopyOptions = std::filesystem::copy_options;
 
    using Time = std::filesystem::file_time_type;
 
 
 
    FilesystemEntry() = default;
 
    explicit FilesystemEntry (const Path& pathToUse);
 
 
    virtual ~FilesystemEntry() = default;
 
    FilesystemEntry (const FilesystemEntry&) = default;
    FilesystemEntry& operator= (const FilesystemEntry&) = default;
 
    FilesystemEntry (FilesystemEntry&&) = default;
    FilesystemEntry& operator= (FilesystemEntry&&) = default;
 
 
    FilesystemEntry& operator= (const Path& newPath);
    FilesystemEntry& operator= (const std::string_view& newPath);
    FilesystemEntry& assignPath (const Path& newPath) noexcept;
 
 
    [[nodiscard]] bool operator== (const FilesystemEntry& other) const noexcept;
    [[nodiscard]] bool operator== (const Path& other) const noexcept;
    [[nodiscard]] bool operator!= (const FilesystemEntry& other) const noexcept;
    [[nodiscard]] bool operator!= (const Path& other) const noexcept;
 
 
    [[nodiscard]] bool operator<(const FilesystemEntry& other) const noexcept;
    [[nodiscard]] bool operator> (const FilesystemEntry& other) const noexcept;
    [[nodiscard]] bool operator<(const Path& other) const noexcept;
    [[nodiscard]] bool operator> (const Path& other) const noexcept;
 
 
    [[nodiscard]] FilesystemEntry operator/ (const std::string_view& subpathName) const;
 
    FilesystemEntry& operator/= (const std::string_view& subpathName);
 
    FilesystemEntry& changeName (const std::string_view& newName);
 
    bool makeAbsoluteRelativeTo (const Path& basePath) noexcept;
 
    bool makeAbsoluteRelativeToCWD() noexcept;
 
 
 
    [[nodiscard]] Path getPath (bool makePreferred = false) const noexcept;
 
    [[nodiscard]] Path getAbsolutePath (bool makePreferred = false) const noexcept;
 
    operator Path() const noexcept;
 
    [[nodiscard]] std::string getName() const noexcept;
 
    [[nodiscard]] Directory getDirectory() const;
 
    [[nodiscard]] Directory getParentDirectory() const;
 
    [[nodiscard]] bool isBelow (const Directory& directory, std::size_t depthLimit = 50) const;
 
    [[nodiscard]] bool isAbsolutePath() const noexcept;
 
    [[nodiscard]] bool isRelativePath() const noexcept;
 
    [[nodiscard]] bool isValid() const noexcept;
 
    [[nodiscard]] bool isHidden() const;
 
    [[nodiscard]] FilesystemEntry getSibling (const std::string_view& siblingName) const;
 
 
 
    [[nodiscard]] virtual bool isFile() const noexcept;
 
    [[nodiscard]] virtual bool isDirectory() const noexcept;
 
    [[nodiscard]] virtual bool isSymLink() const noexcept;
 
    [[nodiscard]] bool exists() const noexcept;
 
    operator bool() const noexcept;
 
    [[nodiscard]] virtual std::uintmax_t sizeInBytes() const;
 
    [[nodiscard]] Time getLastModificationTime() const noexcept;
 
    [[nodiscard]] std::optional<Volume> getVolume() const noexcept;
 
 
 
    [[nodiscard]] std::optional<File> getFileObject() const noexcept;
 
    [[nodiscard]] std::optional<Directory> getDirectoryObject() const noexcept;
 
    [[nodiscard]] std::optional<SymLink> getSymLinkObject() const noexcept;
 
 
 
    virtual bool createIfDoesntExist() const noexcept;
 
    bool deleteIfExists() const noexcept;
 
    bool moveToTrash() noexcept;
 
    void touch() const;
 
    bool touch_noCreate() const;
 
    bool rename (const Path& newPath) noexcept;
 
 
 
    bool setPermissions (FSPerms permissions, PermOptions options = PermOptions::replace) const noexcept;
 
    [[nodiscard]] Permissions getPermissions() const;
 
 
 
    bool copyTo (const Path& dest, CopyOptions options = CopyOptions::update_existing) const noexcept;
 
    bool copyTo (const FilesystemEntry& dest, CopyOptions options = CopyOptions::update_existing) const noexcept;
 
    std::optional<FilesystemEntry> copyToDirectory (const Path& destDirectory, CopyOptions options = CopyOptions::update_existing) const noexcept;
 
    bool copyFrom (const Path& source, CopyOptions options = CopyOptions::update_existing) const noexcept;
    bool copyFrom (const FilesystemEntry& source, CopyOptions options = CopyOptions::update_existing) const noexcept;
 
    bool revealToUserInFileBrowser() const;
 
private:
    bool filenameBeginsWithDot() const;
 
    Path path;
};
 
std::ostream& operator<< (std::ostream& os, const FilesystemEntry& value);
 
}  // namespace limes::files
 
namespace std
{
 
template <>
struct LFILE_EXPORT hash<limes::files::FilesystemEntry> final
{
    size_t operator() (const limes::files::FilesystemEntry& e) const noexcept;
};
}  // namespace std