juce_RangedDirectoryIterator.h

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE ("-Wdeprecated-declarations")
JUCE_BEGIN_IGNORE_WARNINGS_MSVC (4996)

class DirectoryEntry final
{
public:
    File getFile()              const { return file; }

    Time getModificationTime()  const { return modTime; }

    Time getCreationTime()      const { return creationTime; }

    int64 getFileSize()         const { return fileSize; }

    bool isDirectory()          const { return directory; }

    bool isHidden()             const { return hidden; }

    bool isReadOnly()           const { return readOnly; }

    float getEstimatedProgress() const;
 
private:
    std::weak_ptr<DirectoryIterator> iterator;
    File file;
    Time modTime;
    Time creationTime;
    int64 fileSize  = 0;
    bool directory  = false;
    bool hidden     = false;
    bool readOnly   = false;
 
    friend class RangedDirectoryIterator;
};

inline const DirectoryEntry& operator* (const DirectoryEntry& e) noexcept { return e; }
 
//==============================================================================
class RangedDirectoryIterator final
{
public:
    using difference_type   = std::ptrdiff_t;
    using value_type        = DirectoryEntry;
    using reference         = DirectoryEntry;
    using pointer           = void;
    using iterator_category = std::input_iterator_tag;

    RangedDirectoryIterator() = default;

    RangedDirectoryIterator (const File& directory,
                             bool isRecursive,
                             const String& wildCard = "*",
                             int whatToLookFor = File::findFiles,
                             File::FollowSymlinks followSymlinks = File::FollowSymlinks::yes);

    bool operator== (const RangedDirectoryIterator& other) const noexcept
    {
        return iterator == nullptr && other.iterator == nullptr;
    }

    bool operator!= (const RangedDirectoryIterator& other) const noexcept
    {
        return ! operator== (other);
    }

    const DirectoryEntry& operator* () const noexcept { return  entry; }
    const DirectoryEntry* operator->() const noexcept { return &entry; }

    RangedDirectoryIterator& operator++()
    {
        increment();
        return *this;
    }

    DirectoryEntry operator++ (int)
    {
        auto result = *(*this);
        ++(*this);
        return result;
    }
 
private:
    bool next();
    void increment();
 
    std::shared_ptr<DirectoryIterator> iterator;
    DirectoryEntry entry;
};

inline RangedDirectoryIterator begin (const RangedDirectoryIterator& it) { return it; }

inline RangedDirectoryIterator end   (const RangedDirectoryIterator&)    { return {}; }
 
 
JUCE_END_IGNORE_WARNINGS_MSVC
JUCE_END_IGNORE_WARNINGS_GCC_LIKE
 
} // namespace juce