lfilesystem_SymLink.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 <functional>  // for std::hash
#include <optional>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_FilesystemEntry.h"
 
namespace limes::files
{
 
class Directory;
 
class LFILE_EXPORT SymLink final : public FilesystemEntry
{
public:
    using FilesystemEntry::FilesystemEntry;
 
    SymLink (const SymLink&) = default;
    SymLink& operator= (const SymLink&) = default;
 
    SymLink (SymLink&&) = default;
    SymLink& operator= (SymLink&&) = default;
 
    explicit SymLink (const Path& symLinkPath, const FilesystemEntry& linkTarget);
 
    [[nodiscard]] FilesystemEntry follow (std::size_t recursionDepth = 50) const noexcept;
 
    [[nodiscard]] bool references (const FilesystemEntry& entry, std::size_t recursionDepth = 50) const noexcept;
 
    [[nodiscard]] bool referencesSameLocationAs (const SymLink& other) const;
 
    [[nodiscard]] bool isDangling() const noexcept;
 
    [[nodiscard]] bool isSymLink() const noexcept final;
    [[nodiscard]] bool isFile() const noexcept final;
    [[nodiscard]] bool isDirectory() const noexcept final;
 
 
    static std::optional<SymLink> create (const Path& linkPath, const Path& target) noexcept;
    static std::optional<SymLink> create (const Path& linkPath, const FilesystemEntry& target) noexcept;
 
    static std::optional<SymLink> create (const Directory& newDirectory, const Path& target) noexcept;
    static std::optional<SymLink> create (const Directory& newDirectory, const FilesystemEntry& target) noexcept;
 
private:
    [[nodiscard]] FilesystemEntry follow_recurse (std::size_t counter, std::size_t limit) const;
    [[nodiscard]] bool            references_recurse (const FilesystemEntry& entry, std::size_t counter, std::size_t limit) const;
};
 
}  // namespace limes::files
 
namespace std
{
 
template <>
struct LFILE_EXPORT hash<limes::files::SymLink> final
{
    size_t operator() (const limes::files::SymLink& l) const noexcept;
};
 
}  // namespace std