juce/source/src/gui/components/filebrowser/juce_DirectoryContentsList.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #include "../../../core/juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_DirectoryContentsList.h"
  31 #include "../../graphics/imaging/juce_ImageCache.h"
  32
  33
  34 //==============================================================================
  35 DirectoryContentsList::DirectoryContentsList (const FileFilter* const fileFilter_,
  36                                               TimeSliceThread& thread_)
  37    : fileFilter (fileFilter_),
  38      thread (thread_),
  39      fileTypeFlags (File::ignoreHiddenFiles | File::findFiles),
  40      shouldStop (true)
  41 {
  42 }
  43
  44 DirectoryContentsList::~DirectoryContentsList()
  45 {
  46     clear();
  47 }
  48
  49 void DirectoryContentsList::setIgnoresHiddenFiles (const bool shouldIgnoreHiddenFiles)
  50 {
  51     setTypeFlags (shouldIgnoreHiddenFiles ? (fileTypeFlags | File::ignoreHiddenFiles)
  52                                           : (fileTypeFlags & ~File::ignoreHiddenFiles));
  53 }
  54
  55 bool DirectoryContentsList::ignoresHiddenFiles() const
  56 {
  57     return (fileTypeFlags & File::ignoreHiddenFiles) != 0;
  58 }
  59
  60 //==============================================================================
  61 const File& DirectoryContentsList::getDirectory() const
  62 {
  63     return root;
  64 }
  65
  66 void DirectoryContentsList::setDirectory (const File& directory,
  67                                           const bool includeDirectories,
  68                                           const bool includeFiles)
  69 {
  70     jassert (includeDirectories || includeFiles); // you have to speciify at least one of these!
  71
  72     if (directory != root)
  73     {
  74         clear();
  75         root = directory;
  76
  77         // (this forces a refresh when setTypeFlags() is called, rather than triggering two refreshes)
  78         fileTypeFlags &= ~(File::findDirectories | File::findFiles);
  79     }
  80
  81     int newFlags = fileTypeFlags;
  82     if (includeDirectories) newFlags |= File::findDirectories;  else newFlags &= ~File::findDirectories;
  83     if (includeFiles)       newFlags |= File::findFiles;        else newFlags &= ~File::findFiles;
  84
  85     setTypeFlags (newFlags);
  86 }
  87
  88 void DirectoryContentsList::setTypeFlags (const int newFlags)
  89 {
  90     if (fileTypeFlags != newFlags)
  91     {
  92         fileTypeFlags = newFlags;
  93         refresh();
  94     }
  95 }
  96
  97 void DirectoryContentsList::clear()
  98 {
  99     shouldStop = true;
 100     thread.removeTimeSliceClient (this);
 101
 102     fileFindHandle = nullptr;
 103
 104     if (files.size() > 0)
 105     {
 106         files.clear();
 107         changed();
 108     }
 109 }
 110
 111 void DirectoryContentsList::refresh()
 112 {
 113     clear();
 114
 115     if (root.isDirectory())
 116     {
 117         fileFindHandle = new DirectoryIterator (root, false, "*", fileTypeFlags);
 118         shouldStop = false;
 119         thread.addTimeSliceClient (this);
 120     }
 121 }
 122
 123 //==============================================================================
 124 int DirectoryContentsList::getNumFiles() const
 125 {
 126     return files.size();
 127 }
 128
 129 bool DirectoryContentsList::getFileInfo (const int index,
 130                                          FileInfo& result) const
 131 {
 132     const ScopedLock sl (fileListLock);
 133     const FileInfo* const info = files [index];
 134
 135     if (info != nullptr)
 136     {
 137         result = *info;
 138         return true;
 139     }
 140
 141     return false;
 142 }
 143
 144 File DirectoryContentsList::getFile (const int index) const
 145 {
 146     const ScopedLock sl (fileListLock);
 147     const FileInfo* const info = files [index];
 148
 149     if (info != nullptr)
 150         return root.getChildFile (info->filename);
 151
 152     return File::nonexistent;
 153 }
 154
 155 bool DirectoryContentsList::isStillLoading() const
 156 {
 157     return fileFindHandle != nullptr;
 158 }
 159
 160 void DirectoryContentsList::changed()
 161 {
 162     sendChangeMessage();
 163 }
 164
 165 //==============================================================================
 166 int DirectoryContentsList::useTimeSlice()
 167 {
 168     const uint32 startTime = Time::getApproximateMillisecondCounter();
 169     bool hasChanged = false;
 170
 171     for (int i = 100; --i >= 0;)
 172     {
 173         if (! checkNextFile (hasChanged))
 174         {
 175             if (hasChanged)
 176                 changed();
 177
 178             return 500;
 179         }
 180
 181         if (shouldStop || (Time::getApproximateMillisecondCounter() > startTime + 150))
 182             break;
 183     }
 184
 185     if (hasChanged)
 186         changed();
 187
 188     return 0;
 189 }
 190
 191 bool DirectoryContentsList::checkNextFile (bool& hasChanged)
 192 {
 193     if (fileFindHandle != nullptr)
 194     {
 195         bool fileFoundIsDir, isHidden, isReadOnly;
 196         int64 fileSize;
 197         Time modTime, creationTime;
 198
 199         if (fileFindHandle->next (&fileFoundIsDir, &isHidden, &fileSize,
 200                                   &modTime, &creationTime, &isReadOnly))
 201         {
 202             if (addFile (fileFindHandle->getFile(), fileFoundIsDir,
 203                          fileSize, modTime, creationTime, isReadOnly))
 204             {
 205                 hasChanged = true;
 206             }
 207
 208             return true;
 209         }
 210         else
 211         {
 212             fileFindHandle = nullptr;
 213         }
 214     }
 215
 216     return false;
 217 }
 218
 219 int DirectoryContentsList::compareElements (const DirectoryContentsList::FileInfo* const first,
 220                                             const DirectoryContentsList::FileInfo* const second)
 221 {
 222    #if JUCE_WINDOWS
 223     if (first->isDirectory != second->isDirectory)
 224         return first->isDirectory ? -1 : 1;
 225    #endif
 226
 227     return first->filename.compareIgnoreCase (second->filename);
 228 }
 229
 230 bool DirectoryContentsList::addFile (const File& file,
 231                                      const bool isDir,
 232                                      const int64 fileSize,
 233                                      const Time& modTime,
 234                                      const Time& creationTime,
 235                                      const bool isReadOnly)
 236 {
 237     if (fileFilter == nullptr
 238          || ((! isDir) && fileFilter->isFileSuitable (file))
 239          || (isDir && fileFilter->isDirectorySuitable (file)))
 240     {
 241         ScopedPointer <FileInfo> info (new FileInfo());
 242
 243         info->filename = file.getFileName();
 244         info->fileSize = fileSize;
 245         info->modificationTime = modTime;
 246         info->creationTime = creationTime;
 247         info->isDirectory = isDir;
 248         info->isReadOnly = isReadOnly;
 249
 250         const ScopedLock sl (fileListLock);
 251
 252         for (int i = files.size(); --i >= 0;)
 253             if (files.getUnchecked(i)->filename == info->filename)
 254                 return false;
 255
 256         files.addSorted (*this, info.release());
 257         return true;
 258     }
 259
 260     return false;
 261 }
 262
 263 END_JUCE_NAMESPACE