juce_DirectoryContentsList.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_DIRECTORYCONTENTSLIST_H_INCLUDED
#define JUCE_DIRECTORYCONTENTSLIST_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  DirectoryContentsList   : public ChangeBroadcaster,
                                          private TimeSliceClient
{
public:
    //==============================================================================
    DirectoryContentsList (const FileFilter* fileFilter,
                           TimeSliceThread& threadToUse);
 
    ~DirectoryContentsList();
 
 
    //==============================================================================
    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                        { return files.size(); }
 
    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;
    TimeSliceThread& thread;
    int fileTypeFlags;
 
    CriticalSection fileListLock;
    OwnedArray<FileInfo> files;
 
    ScopedPointer<DirectoryIterator> fileFindHandle;
    bool volatile shouldStop;
 
    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)
};
 
 
#endif   // JUCE_DIRECTORYCONTENTSLIST_H_INCLUDED