juce/source/src/gui/components/filebrowser/juce_FileBrowserComponent.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_FileBrowserComponent.h"
  31 #include "../lookandfeel/juce_LookAndFeel.h"
  32 #include "../../graphics/drawables/juce_DrawablePath.h"
  33 #include "../../../text/juce_LocalisedStrings.h"
  34 #include "../../../core/juce_SystemStats.h"
  35 #include "juce_FileListComponent.h"
  36 #include "juce_FileTreeComponent.h"
  37
  38
  39 //==============================================================================
  40 FileBrowserComponent::FileBrowserComponent (int flags_,
  41                                             const File& initialFileOrDirectory,
  42                                             const FileFilter* fileFilter_,
  43                                             FilePreviewComponent* previewComp_)
  44    : FileFilter (String::empty),
  45      fileFilter (fileFilter_),
  46      flags (flags_),
  47      previewComp (previewComp_),
  48      currentPathBox ("path"),
  49      fileLabel ("f", TRANS ("file:")),
  50      thread ("Juce FileBrowser")
  51 {
  52     // You need to specify one or other of the open/save flags..
  53     jassert ((flags & (saveMode | openMode)) != 0);
  54     jassert ((flags & (saveMode | openMode)) != (saveMode | openMode));
  55
  56     // You need to specify at least one of these flags..
  57     jassert ((flags & (canSelectFiles | canSelectDirectories)) != 0);
  58
  59     String filename;
  60
  61     if (initialFileOrDirectory == File::nonexistent)
  62     {
  63         currentRoot = File::getCurrentWorkingDirectory();
  64     }
  65     else if (initialFileOrDirectory.isDirectory())
  66     {
  67         currentRoot = initialFileOrDirectory;
  68     }
  69     else
  70     {
  71         chosenFiles.add (initialFileOrDirectory);
  72         currentRoot = initialFileOrDirectory.getParentDirectory();
  73         filename = initialFileOrDirectory.getFileName();
  74     }
  75
  76     fileList = new DirectoryContentsList (this, thread);
  77
  78     if ((flags & useTreeView) != 0)
  79     {
  80         FileTreeComponent* const tree = new FileTreeComponent (*fileList);
  81         fileListComponent = tree;
  82
  83         if ((flags & canSelectMultipleItems) != 0)
  84             tree->setMultiSelectEnabled (true);
  85
  86         addAndMakeVisible (tree);
  87     }
  88     else
  89     {
  90         FileListComponent* const list = new FileListComponent (*fileList);
  91         fileListComponent = list;
  92         list->setOutlineThickness (1);
  93
  94         if ((flags & canSelectMultipleItems) != 0)
  95             list->setMultipleSelectionEnabled (true);
  96
  97         addAndMakeVisible (list);
  98     }
  99
 100     fileListComponent->addListener (this);
 101
 102     addAndMakeVisible (&currentPathBox);
 103     currentPathBox.setEditableText (true);
 104     resetRecentPaths();
 105     currentPathBox.addListener (this);
 106
 107     addAndMakeVisible (&filenameBox);
 108     filenameBox.setMultiLine (false);
 109     filenameBox.setSelectAllWhenFocused (true);
 110     filenameBox.setText (filename, false);
 111     filenameBox.addListener (this);
 112     filenameBox.setReadOnly ((flags & (filenameBoxIsReadOnly | canSelectMultipleItems)) != 0);
 113
 114     addAndMakeVisible (&fileLabel);
 115     fileLabel.attachToComponent (&filenameBox, true);
 116
 117     addAndMakeVisible (goUpButton = getLookAndFeel().createFileBrowserGoUpButton());
 118     goUpButton->addListener (this);
 119     goUpButton->setTooltip (TRANS ("go up to parent directory"));
 120
 121     if (previewComp != nullptr)
 122         addAndMakeVisible (previewComp);
 123
 124     setRoot (currentRoot);
 125
 126     thread.startThread (4);
 127 }
 128
 129 FileBrowserComponent::~FileBrowserComponent()
 130 {
 131     fileListComponent = nullptr;
 132     fileList = nullptr;
 133     thread.stopThread (10000);
 134 }
 135
 136 //==============================================================================
 137 void FileBrowserComponent::addListener (FileBrowserListener* const newListener)
 138 {
 139     listeners.add (newListener);
 140 }
 141
 142 void FileBrowserComponent::removeListener (FileBrowserListener* const listener)
 143 {
 144     listeners.remove (listener);
 145 }
 146
 147 //==============================================================================
 148 bool FileBrowserComponent::isSaveMode() const noexcept
 149 {
 150     return (flags & saveMode) != 0;
 151 }
 152
 153 int FileBrowserComponent::getNumSelectedFiles() const noexcept
 154 {
 155     if (chosenFiles.size() == 0 && currentFileIsValid())
 156         return 1;
 157
 158     return chosenFiles.size();
 159 }
 160
 161 File FileBrowserComponent::getSelectedFile (int index) const noexcept
 162 {
 163     if ((flags & canSelectDirectories) != 0 && filenameBox.getText().isEmpty())
 164         return currentRoot;
 165
 166     if (! filenameBox.isReadOnly())
 167         return currentRoot.getChildFile (filenameBox.getText());
 168
 169     return chosenFiles[index];
 170 }
 171
 172 bool FileBrowserComponent::currentFileIsValid() const
 173 {
 174     if (isSaveMode())
 175         return ! getSelectedFile (0).isDirectory();
 176     else
 177         return getSelectedFile (0).exists();
 178 }
 179
 180 File FileBrowserComponent::getHighlightedFile() const noexcept
 181 {
 182     return fileListComponent->getSelectedFile (0);
 183 }
 184
 185 void FileBrowserComponent::deselectAllFiles()
 186 {
 187     fileListComponent->deselectAllFiles();
 188 }
 189
 190 //==============================================================================
 191 bool FileBrowserComponent::isFileSuitable (const File& file) const
 192 {
 193     return (flags & canSelectFiles) != 0 && (fileFilter == nullptr || fileFilter->isFileSuitable (file));
 194 }
 195
 196 bool FileBrowserComponent::isDirectorySuitable (const File&) const
 197 {
 198     return true;
 199 }
 200
 201 bool FileBrowserComponent::isFileOrDirSuitable (const File& f) const
 202 {
 203     if (f.isDirectory())
 204         return (flags & canSelectDirectories) != 0
 205                 && (fileFilter == nullptr || fileFilter->isDirectorySuitable (f));
 206
 207     return (flags & canSelectFiles) != 0 && f.exists()
 208             && (fileFilter == nullptr || fileFilter->isFileSuitable (f));
 209 }
 210
 211 //==============================================================================
 212 const File& FileBrowserComponent::getRoot() const
 213 {
 214     return currentRoot;
 215 }
 216
 217 void FileBrowserComponent::setRoot (const File& newRootDirectory)
 218 {
 219     if (currentRoot != newRootDirectory)
 220     {
 221         fileListComponent->scrollToTop();
 222
 223         String path (newRootDirectory.getFullPathName());
 224
 225         if (path.isEmpty())
 226             path = File::separatorString;
 227
 228         StringArray rootNames, rootPaths;
 229         getRoots (rootNames, rootPaths);
 230
 231         if (! rootPaths.contains (path, true))
 232         {
 233             bool alreadyListed = false;
 234
 235             for (int i = currentPathBox.getNumItems(); --i >= 0;)
 236             {
 237                 if (currentPathBox.getItemText (i).equalsIgnoreCase (path))
 238                 {
 239                     alreadyListed = true;
 240                     break;
 241                 }
 242             }
 243
 244             if (! alreadyListed)
 245                 currentPathBox.addItem (path, currentPathBox.getNumItems() + 2);
 246         }
 247     }
 248
 249     currentRoot = newRootDirectory;
 250     fileList->setDirectory (currentRoot, true, true);
 251
 252     String currentRootName (currentRoot.getFullPathName());
 253     if (currentRootName.isEmpty())
 254         currentRootName = File::separatorString;
 255
 256     currentPathBox.setText (currentRootName, true);
 257
 258     goUpButton->setEnabled (currentRoot.getParentDirectory().isDirectory()
 259                              && currentRoot.getParentDirectory() != currentRoot);
 260 }
 261
 262 void FileBrowserComponent::resetRecentPaths()
 263 {
 264     currentPathBox.clear();
 265
 266     StringArray rootNames, rootPaths;
 267     getRoots (rootNames, rootPaths);
 268
 269     for (int i = 0; i < rootNames.size(); ++i)
 270     {
 271         if (rootNames[i].isEmpty())
 272             currentPathBox.addSeparator();
 273         else
 274             currentPathBox.addItem (rootNames[i], i + 1);
 275     }
 276
 277     currentPathBox.addSeparator();
 278 }
 279
 280 void FileBrowserComponent::goUp()
 281 {
 282     setRoot (getRoot().getParentDirectory());
 283 }
 284
 285 void FileBrowserComponent::refresh()
 286 {
 287     fileList->refresh();
 288 }
 289
 290 void FileBrowserComponent::setFileFilter (const FileFilter* const newFileFilter)
 291 {
 292     if (fileFilter != newFileFilter)
 293     {
 294         fileFilter = newFileFilter;
 295         refresh();
 296     }
 297 }
 298
 299 const String FileBrowserComponent::getActionVerb() const
 300 {
 301     return isSaveMode() ? TRANS("Save") : TRANS("Open");
 302 }
 303
 304 FilePreviewComponent* FileBrowserComponent::getPreviewComponent() const noexcept
 305 {
 306     return previewComp;
 307 }
 308
 309 //==============================================================================
 310 void FileBrowserComponent::resized()
 311 {
 312     getLookAndFeel()
 313         .layoutFileBrowserComponent (*this, fileListComponent, previewComp,
 314                                      &currentPathBox, &filenameBox, goUpButton);
 315 }
 316
 317 //==============================================================================
 318 void FileBrowserComponent::sendListenerChangeMessage()
 319 {
 320     Component::BailOutChecker checker (this);
 321
 322     if (previewComp != nullptr)
 323         previewComp->selectedFileChanged (getSelectedFile (0));
 324
 325     // You shouldn't delete the browser when the file gets changed!
 326     jassert (! checker.shouldBailOut());
 327
 328     listeners.callChecked (checker, &FileBrowserListener::selectionChanged);
 329 }
 330
 331 void FileBrowserComponent::selectionChanged()
 332 {
 333     StringArray newFilenames;
 334     bool resetChosenFiles = true;
 335
 336     for (int i = 0; i < fileListComponent->getNumSelectedFiles(); ++i)
 337     {
 338         const File f (fileListComponent->getSelectedFile (i));
 339
 340         if (isFileOrDirSuitable (f))
 341         {
 342             if (resetChosenFiles)
 343             {
 344                 chosenFiles.clear();
 345                 resetChosenFiles = false;
 346             }
 347
 348             chosenFiles.add (f);
 349             newFilenames.add (f.getRelativePathFrom (getRoot()));
 350         }
 351     }
 352
 353     if (newFilenames.size() > 0)
 354         filenameBox.setText (newFilenames.joinIntoString (", "), false);
 355
 356     sendListenerChangeMessage();
 357 }
 358
 359 void FileBrowserComponent::fileClicked (const File& f, const MouseEvent& e)
 360 {
 361     Component::BailOutChecker checker (this);
 362     listeners.callChecked (checker, &FileBrowserListener::fileClicked, f, e);
 363 }
 364
 365 void FileBrowserComponent::fileDoubleClicked (const File& f)
 366 {
 367     if (f.isDirectory())
 368     {
 369         setRoot (f);
 370
 371         if ((flags & canSelectDirectories) != 0)
 372             filenameBox.setText (String::empty);
 373     }
 374     else
 375     {
 376         Component::BailOutChecker checker (this);
 377         listeners.callChecked (checker, &FileBrowserListener::fileDoubleClicked, f);
 378     }
 379 }
 380
 381 bool FileBrowserComponent::keyPressed (const KeyPress& key)
 382 {
 383     (void) key;
 384
 385 #if JUCE_LINUX || JUCE_WINDOWS
 386     if (key.getModifiers().isCommandDown()
 387          && (key.getKeyCode() == 'H' || key.getKeyCode() == 'h'))
 388     {
 389         fileList->setIgnoresHiddenFiles (! fileList->ignoresHiddenFiles());
 390         fileList->refresh();
 391         return true;
 392     }
 393 #endif
 394
 395     return false;
 396 }
 397
 398 //==============================================================================
 399 void FileBrowserComponent::textEditorTextChanged (TextEditor&)
 400 {
 401     sendListenerChangeMessage();
 402 }
 403
 404 void FileBrowserComponent::textEditorReturnKeyPressed (TextEditor&)
 405 {
 406     if (filenameBox.getText().containsChar (File::separator))
 407     {
 408         const File f (currentRoot.getChildFile (filenameBox.getText()));
 409
 410         if (f.isDirectory())
 411         {
 412             setRoot (f);
 413             chosenFiles.clear();
 414             filenameBox.setText (String::empty);
 415         }
 416         else
 417         {
 418             setRoot (f.getParentDirectory());
 419             chosenFiles.clear();
 420             chosenFiles.add (f);
 421             filenameBox.setText (f.getFileName());
 422         }
 423     }
 424     else
 425     {
 426         fileDoubleClicked (getSelectedFile (0));
 427     }
 428 }
 429
 430 void FileBrowserComponent::textEditorEscapeKeyPressed (TextEditor&)
 431 {
 432 }
 433
 434 void FileBrowserComponent::textEditorFocusLost (TextEditor&)
 435 {
 436     if (! isSaveMode())
 437         selectionChanged();
 438 }
 439
 440 //==============================================================================
 441 void FileBrowserComponent::buttonClicked (Button*)
 442 {
 443     goUp();
 444 }
 445
 446 void FileBrowserComponent::comboBoxChanged (ComboBox*)
 447 {
 448     const String newText (currentPathBox.getText().trim().unquoted());
 449
 450     if (newText.isNotEmpty())
 451     {
 452         const int index = currentPathBox.getSelectedId() - 1;
 453
 454         StringArray rootNames, rootPaths;
 455         getRoots (rootNames, rootPaths);
 456
 457         if (rootPaths [index].isNotEmpty())
 458         {
 459             setRoot (File (rootPaths [index]));
 460         }
 461         else
 462         {
 463             File f (newText);
 464
 465             for (;;)
 466             {
 467                 if (f.isDirectory())
 468                 {
 469                     setRoot (f);
 470                     break;
 471                 }
 472
 473                 if (f.getParentDirectory() == f)
 474                     break;
 475
 476                 f = f.getParentDirectory();
 477             }
 478         }
 479     }
 480 }
 481
 482 void FileBrowserComponent::getRoots (StringArray& rootNames, StringArray& rootPaths)
 483 {
 484    #if JUCE_WINDOWS
 485     Array<File> roots;
 486     File::findFileSystemRoots (roots);
 487     rootPaths.clear();
 488
 489     for (int i = 0; i < roots.size(); ++i)
 490     {
 491         const File& drive = roots.getReference(i);
 492
 493         String name (drive.getFullPathName());
 494         rootPaths.add (name);
 495
 496         if (drive.isOnHardDisk())
 497         {
 498             String volume (drive.getVolumeLabel());
 499
 500             if (volume.isEmpty())
 501                 volume = TRANS("Hard Drive");
 502
 503             name << " [" << volume << ']';
 504         }
 505         else if (drive.isOnCDRomDrive())
 506         {
 507             name << TRANS(" [CD/DVD drive]");
 508         }
 509
 510         rootNames.add (name);
 511     }
 512
 513     rootPaths.add (String::empty);
 514     rootNames.add (String::empty);
 515
 516     rootPaths.add (File::getSpecialLocation (File::userDocumentsDirectory).getFullPathName());
 517     rootNames.add ("Documents");
 518     rootPaths.add (File::getSpecialLocation (File::userDesktopDirectory).getFullPathName());
 519     rootNames.add ("Desktop");
 520
 521    #elif JUCE_MAC
 522     rootPaths.add (File::getSpecialLocation (File::userHomeDirectory).getFullPathName());
 523     rootNames.add ("Home folder");
 524     rootPaths.add (File::getSpecialLocation (File::userDocumentsDirectory).getFullPathName());
 525     rootNames.add ("Documents");
 526     rootPaths.add (File::getSpecialLocation (File::userDesktopDirectory).getFullPathName());
 527     rootNames.add ("Desktop");
 528
 529     rootPaths.add (String::empty);
 530     rootNames.add (String::empty);
 531
 532     Array <File> volumes;
 533     File vol ("/Volumes");
 534     vol.findChildFiles (volumes, File::findDirectories, false);
 535
 536     for (int i = 0; i < volumes.size(); ++i)
 537     {
 538         const File& volume = volumes.getReference(i);
 539
 540         if (volume.isDirectory() && ! volume.getFileName().startsWithChar ('.'))
 541         {
 542             rootPaths.add (volume.getFullPathName());
 543             rootNames.add (volume.getFileName());
 544         }
 545     }
 546
 547    #else
 548     rootPaths.add ("/");
 549     rootNames.add ("/");
 550     rootPaths.add (File::getSpecialLocation (File::userHomeDirectory).getFullPathName());
 551     rootNames.add ("Home folder");
 552     rootPaths.add (File::getSpecialLocation (File::userDesktopDirectory).getFullPathName());
 553     rootNames.add ("Desktop");
 554    #endif
 555 }
 556
 557
 558 END_JUCE_NAMESPACE