lfilesystem_Directory.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>
#include <cstdint>
#include <string>
#include <vector>
#include <memory>
#include <iterator>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_FilesystemEntry.h"
#include "lfilesystem/lfilesystem_File.h"
#include "lfilesystem/lfilesystem_SymLink.h"
 
namespace limes::files
{
 
class LFILE_EXPORT Directory final : public FilesystemEntry
{
public:
    using FilesystemEntry::FilesystemEntry;
 
    Directory (const Directory&) = default;
    Directory& operator= (const Directory&) = default;
 
    Directory (Directory&&) = default;
    Directory& operator= (Directory&&) = default;
 
 
    using FileCallback = std::function<void (const File&)>;
 
    using DirectoryCallback = std::function<void (const Directory&)>;
 
    using SymLinkCallback = std::function<void (const SymLink&)>;
 
    using FilesystemEntryCallback = std::function<void (const FilesystemEntry&)>;
 
 
 
    Directory& operator= (const Path& newPath);
    Directory& operator= (const std::string_view& newPath);
 
 
    [[nodiscard]] bool contains (const FilesystemEntry& entry, std::size_t depthLimit = 50) const;
 
    [[nodiscard]] bool contains (const std::string_view& childName) const;
 
    [[nodiscard]] bool isEmpty() const;
 
    [[nodiscard]] std::uintmax_t sizeInBytes() const final;
 
    [[nodiscard]] bool isDirectory() const noexcept final;
    [[nodiscard]] bool isFile() const noexcept final;
    [[nodiscard]] bool isSymLink() const noexcept final;
 
 
    bool createIfDoesntExist() const noexcept final;
 
    [[nodiscard]] Path getRelativePath (const Path& inputPath) const;
 
 
    [[nodiscard]] File getChildFile (const std::string_view& filename, bool createIfNeeded = false) const;
 
    [[nodiscard]] std::vector<File> getChildFiles (bool recurse = true, bool includeHiddenFiles = true) const;
 
    void iterateFiles (FileCallback&& callback, bool recurse = true, bool includeHiddenFiles = true) const;
 
 
 
    [[nodiscard]] bool containsSubdirectories() const;
 
    [[nodiscard]] Directory getChildDirectory (const std::string_view& subdirectoryName, bool createIfNeeded = false) const;
 
    [[nodiscard]] std::vector<Directory> getChildDirectories (bool recurse = true, bool includeHiddenFiles = true) const;
 
    void iterateDirectories (DirectoryCallback&& callback, bool recurse = true, bool includeHiddenFiles = true) const;
 
 
 
    [[nodiscard]] SymLink createChildSymLink (const std::string_view& symLinkName,
                                              const FilesystemEntry&  symLinkTarget) const;
 
    [[nodiscard]] std::vector<SymLink> getChildSymLinks (bool recurse = true, bool includeHiddenFiles = true) const;
 
    void iterateSymLinks (SymLinkCallback&& callback, bool recurse = true, bool includeHiddenFiles = true) const;
 
 
 
    [[nodiscard]] FilesystemEntry getChild (const std::string_view& childName, bool createIfNeeded = false) const;
 
    [[nodiscard]] std::vector<FilesystemEntry> getAllChildren (bool recurse = true, bool includeHiddenFiles = true) const;
 
    void iterateAllChildren (FileCallback&&      fileCallback,
                             DirectoryCallback&& directoryCallback,
                             SymLinkCallback&&   symLinkCallback,
                             bool                recurse            = true,
                             bool                includeHiddenFiles = true) const;
 
    void iterateAllChildren (FilesystemEntryCallback&& callback,
                             bool                      recurse            = true,
                             bool                      includeHiddenFiles = true) const;
 
 
    struct LFILE_EXPORT Iterator final
    {
    public:
        using iterator_category = std::forward_iterator_tag;
        using value_type        = FilesystemEntry;
        using difference_type   = std::ptrdiff_t;
        using pointer           = FilesystemEntry*;
        using reference         = FilesystemEntry&;
 
        Iterator&              operator++();
        [[nodiscard]] Iterator operator++ (int);
        bool                   operator== (Iterator other);
        bool                   operator!= (Iterator other);
 
        reference operator*() const;
        pointer   operator->() const;
 
        explicit Iterator();
 
        Iterator (const Iterator&) = default;
        Iterator& operator= (const Iterator&) = default;
 
        Iterator (Iterator&&) = default;
        Iterator& operator= (Iterator&&) = default;
 
    private:
        using VectorType = std::vector<FilesystemEntry>;
 
        explicit Iterator (VectorType&& v);
 
        std::shared_ptr<VectorType> entries { nullptr };
 
        VectorType::size_type idx { 0UL };
 
        friend class Directory;
    };
 
    [[nodiscard]] Iterator begin() const;
 
    [[nodiscard]] Iterator end() const;
 
 
    bool setAsWorkingDirectory() const;
 
    [[nodiscard]] bool isCurrentWorkingDirectory() const;
 
};
 
}  // namespace limes::files