juce/source/src/audio/plugin_host/juce_PluginDirectoryScanner.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_PluginDirectoryScanner.h"
  31 #include "juce_AudioPluginFormat.h"
  32 #include "../../io/files/juce_DirectoryIterator.h"
  33
  34
  35 //==============================================================================
  36 PluginDirectoryScanner::PluginDirectoryScanner (KnownPluginList& listToAddTo,
  37                                                 AudioPluginFormat& formatToLookFor,
  38                                                 FileSearchPath directoriesToSearch,
  39                                                 const bool recursive,
  40                                                 const File& deadMansPedalFile_)
  41     : list (listToAddTo),
  42       format (formatToLookFor),
  43       deadMansPedalFile (deadMansPedalFile_),
  44       nextIndex (0),
  45       progress (0)
  46 {
  47     directoriesToSearch.removeRedundantPaths();
  48
  49     filesOrIdentifiersToScan = format.searchPathsForPlugins (directoriesToSearch, recursive);
  50
  51     // If any plugins have crashed recently when being loaded, move them to the
  52     // end of the list to give the others a chance to load correctly..
  53     const StringArray crashedPlugins (getDeadMansPedalFile());
  54
  55     for (int i = 0; i < crashedPlugins.size(); ++i)
  56     {
  57         const String f = crashedPlugins[i];
  58
  59         for (int j = filesOrIdentifiersToScan.size(); --j >= 0;)
  60             if (f == filesOrIdentifiersToScan[j])
  61                 filesOrIdentifiersToScan.move (j, -1);
  62     }
  63 }
  64
  65 PluginDirectoryScanner::~PluginDirectoryScanner()
  66 {
  67 }
  68
  69 //==============================================================================
  70 const String PluginDirectoryScanner::getNextPluginFileThatWillBeScanned() const
  71 {
  72     return format.getNameOfPluginFromIdentifier (filesOrIdentifiersToScan [nextIndex]);
  73 }
  74
  75 bool PluginDirectoryScanner::scanNextFile (const bool dontRescanIfAlreadyInList)
  76 {
  77     String file (filesOrIdentifiersToScan [nextIndex]);
  78
  79     if (file.isNotEmpty() && ! list.isListingUpToDate (file))
  80     {
  81         OwnedArray <PluginDescription> typesFound;
  82
  83         // Add this plugin to the end of the dead-man's pedal list in case it crashes...
  84         StringArray crashedPlugins (getDeadMansPedalFile());
  85         crashedPlugins.removeString (file);
  86         crashedPlugins.add (file);
  87         setDeadMansPedalFile (crashedPlugins);
  88
  89         list.scanAndAddFile (file,
  90                              dontRescanIfAlreadyInList,
  91                              typesFound,
  92                              format);
  93
  94         // Managed to load without crashing, so remove it from the dead-man's-pedal..
  95         crashedPlugins.removeString (file);
  96         setDeadMansPedalFile (crashedPlugins);
  97
  98         if (typesFound.size() == 0)
  99             failedFiles.add (file);
 100     }
 101
 102     return skipNextFile();
 103 }
 104
 105 bool PluginDirectoryScanner::skipNextFile()
 106 {
 107     if (nextIndex >= filesOrIdentifiersToScan.size())
 108         return false;
 109
 110     progress = ++nextIndex / (float) filesOrIdentifiersToScan.size();
 111     return nextIndex < filesOrIdentifiersToScan.size();
 112 }
 113
 114 StringArray PluginDirectoryScanner::getDeadMansPedalFile()
 115 {
 116     StringArray lines;
 117
 118     if (deadMansPedalFile != File::nonexistent)
 119     {
 120         lines.addLines (deadMansPedalFile.loadFileAsString());
 121         lines.removeEmptyStrings();
 122     }
 123
 124     return lines;
 125 }
 126
 127 void PluginDirectoryScanner::setDeadMansPedalFile (const StringArray& newContents)
 128 {
 129     if (deadMansPedalFile != File::nonexistent)
 130         deadMansPedalFile.replaceWithText (newContents.joinIntoString ("\n"), true, true);
 131 }
 132
 133
 134 END_JUCE_NAMESPACE