juce_DirectoryContentsList.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   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.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   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
{
 
//==============================================================================
class JUCE_API  DirectoryContentsList   : public ChangeBroadcaster,
                                          private TimeSliceClient
{
public:
    //==============================================================================
    DirectoryContentsList (const FileFilter* fileFilter,
                           TimeSliceThread& threadToUse);

    ~DirectoryContentsList() override;
 
 
    //==============================================================================
    const File& getDirectory() const noexcept               { return root; }

    void setDirectory (const File& directory,
                       bool includeDirectories,
                       bool includeFiles);

    bool isFindingDirectories() const noexcept              { return (fileTypeFlags & File::findDirectories) != 0; }

    bool isFindingFiles() const noexcept                    { return (fileTypeFlags & File::findFiles) != 0; }

    void clear();

    void refresh();

    bool isStillLoading() const;

    void setIgnoresHiddenFiles (bool shouldIgnoreHiddenFiles);

    bool ignoresHiddenFiles() const;

    void setFileFilter (const FileFilter* newFileFilter);
 
    //==============================================================================
    struct FileInfo
    {
        //==============================================================================
        String filename;

        int64 fileSize;

        Time modificationTime;

        Time creationTime;

        bool isDirectory;

        bool isReadOnly;
    };
 
    //==============================================================================
    int getNumFiles() const noexcept;

    bool getFileInfo (int index, FileInfo& resultInfo) const;

    File getFile (int index) const;

    const FileFilter* getFilter() const noexcept            { return fileFilter; }

    bool contains (const File&) const;
 
    //==============================================================================
    TimeSliceThread& getTimeSliceThread() const noexcept    { return thread; }
 
private:
    File root;
    const FileFilter* fileFilter = nullptr;
    TimeSliceThread& thread;
    int fileTypeFlags = File::ignoreHiddenFiles | File::findFiles;
 
    CriticalSection fileListLock;
    OwnedArray<FileInfo> files;
 
    std::unique_ptr<RangedDirectoryIterator> fileFindHandle;
    std::atomic<bool> shouldStop { true }, isSearching { false };
 
    bool wasEmpty = true;
 
    int useTimeSlice() override;
    void stopSearching();
    void changed();
    bool checkNextFile (bool& hasChanged);
    bool addFile (const File&, bool isDir, int64 fileSize, Time modTime,
                  Time creationTime, bool isReadOnly);
    void setTypeFlags (int);
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (DirectoryContentsList)
};
 
} // namespace juce