Projucer: Removed some unused methods from ProjucerApplication and refactored the DemoRunner scanning code to cache previously found files

extras/Projucer/Source/Application/jucer_Application.cpp

@@ -201,6 +201,14 @@ void ProjucerApplication::initialiseWindows (const String& commandLine)
         showApplicationUsageDataAgreementPopup();
 }
 
+static void deleteTemporaryFiles()
+{
+    auto tempDirectory = File::getSpecialLocation (File::SpecialLocationType::tempDirectory).getChildFile ("PIPs");
+
+    if (tempDirectory.exists())
+        tempDirectory.deleteRecursively();
+}
+
 void ProjucerApplication::shutdown()
 {
     if (server != nullptr)
@@ -611,6 +619,18 @@ void ProjucerApplication::createExamplesPopupMenu (PopupMenu& menu) noexcept
     }
 }
 
+//==========================================================================
+static File getJUCEExamplesDirectoryPathFromGlobal()
+{
+    auto globalPath = File::createFileWithoutCheckingPath (getAppSettings().getStoredPath (Ids::jucePath, TargetOS::getThisOS()).get().toString()
+                                                                           .replace ("~", File::getSpecialLocation (File::userHomeDirectory).getFullPathName()));
+
+    if (globalPath.exists())
+        return File (globalPath).getChildFile ("examples");
+
+    return {};
+}
+
 Array<File> ProjucerApplication::getSortedExampleDirectories() noexcept
 {
     Array<File> exampleDirectories;
@@ -668,19 +688,10 @@ bool ProjucerApplication::findWindowAndOpenPIP (const File& pip)
     return false;
 }
 
-File ProjucerApplication::getJUCEExamplesDirectoryPathFromGlobal() noexcept
-{
-    auto globalPath = getAppSettings().getStoredPath (Ids::jucePath).toString();
-
-    if (globalPath.isNotEmpty())
-        return File (globalPath).getChildFile ("examples");
-
-    return {};
-}
-
 void ProjucerApplication::findAndLaunchExample (int selectedIndex)
 {
     File example;
+
     for (auto& dir : getSortedExampleDirectories())
     {
         auto exampleFiles = getSortedExampleFilesInDirectory (dir);
@@ -705,115 +716,176 @@ void ProjucerApplication::findAndLaunchExample (int selectedIndex)
     Analytics::getInstance()->logEvent ("Example Opened", data, ProjucerAnalyticsEvent::exampleEvent);
 }
 
-File ProjucerApplication::findDemoRunnerExecutable() noexcept
+//==========================================================================
+static String getPlatformSpecificFileExtension()
 {
-    auto buildsPath = getJUCEExamplesDirectoryPathFromGlobal().getChildFile ("DemoRunner").getChildFile ("Builds");
+   #if JUCE_MAC
+    return ".app";
+   #elif JUCE_WINDOWS
+    return ".exe";
+   #elif JUCE_LINUX
+    return {};
+   #endif
+
+    jassertfalse;
+    return {};
+}
+
+static File getPlatformSpecificProjectFolder()
+{
+    auto buildsFolder = getJUCEExamplesDirectoryPathFromGlobal().getChildFile ("DemoRunner").getChildFile ("Builds");
 
-    if (! buildsPath.exists())
+    if (! buildsFolder.exists())
         return {};
 
-    String extension;
+   #if JUCE_MAC
+    return buildsFolder.getChildFile ("MacOSX");
+   #elif JUCE_WINDOWS
+    return buildsFolder.getChildFile ("VisualStudio2017");
+   #elif JUCE_LINUX
+    return buildsFolder.getChildFile ("LinuxMakefile");
+   #endif
+
+    jassertfalse;
+    return {};
+}
+
+static File tryToFindDemoRunnerExecutableInBuilds()
+{
+    auto projectFolder = getPlatformSpecificProjectFolder();
 
    #if JUCE_MAC
-    auto osxBuildFolder = buildsPath.getChildFile ("MacOSX").getChildFile ("build");
+    projectFolder = projectFolder.getChildFile ("build");
+    auto demoRunnerExecutable = projectFolder.getChildFile ("Release").getChildFile ("DemoRunner.app");
 
-    auto demoRunnerExecutable = osxBuildFolder.getChildFile ("Release").getChildFile ("DemoRunner.app");
     if (demoRunnerExecutable.exists())
         return demoRunnerExecutable;
 
-    demoRunnerExecutable = osxBuildFolder.getChildFile ("Debug").getChildFile ("DemoRunner.app");
+    demoRunnerExecutable = projectFolder.getChildFile ("Debug").getChildFile ("DemoRunner.app");
+
     if (demoRunnerExecutable.exists())
         return demoRunnerExecutable;
-
-    extension = ".app";
    #elif JUCE_WINDOWS
-    auto windowsBuildFolder = buildsPath.getChildFile ("VisualStudio2017").getChildFile ("x64");
+    projectFolder = projectFolder.getChildFile ("x64");
+    auto demoRunnerExecutable = projectFolder.getChildFile ("Release").getChildFile ("App").getChildFile ("DemoRunner.exe");
 
-    auto demoRunnerExecutable = windowsBuildFolder.getChildFile ("Release").getChildFile ("App").getChildFile ("DemoRunner.exe");
     if (demoRunnerExecutable.existsAsFile())
         return demoRunnerExecutable;
 
-    demoRunnerExecutable = windowsBuildFolder.getChildFile ("Debug").getChildFile ("App").getChildFile ("DemoRunner.exe");
+    demoRunnerExecutable = projectFolder.getChildFile ("Debug").getChildFile ("App").getChildFile ("DemoRunner.exe");
+
     if (demoRunnerExecutable.existsAsFile())
         return demoRunnerExecutable;
-
-    extension = ".exe";
    #elif JUCE_LINUX
-    auto linuxBuildFolder = buildsPath.getChildFile ("LinuxMakefile").getChildFile ("build");
-
-    auto demoRunnerExecutable = linuxBuildFolder.getChildFile ("DemoRunner");
+    projectFolder = projectFolder.getChildFile ("LinuxMakefile").getChildFile ("build");
+    auto demoRunnerExecutable = projectFolder.getChildFile ("DemoRunner");
 
     if (demoRunnerExecutable.existsAsFile())
         return demoRunnerExecutable;
+   #endif
+
+    return {};
+}
+
+static File tryToFindPrebuiltDemoRunnerExecutable()
+{
+    auto prebuiltFile = File (getAppSettings().getStoredPath (Ids::jucePath, TargetOS::getThisOS()).get().toString())
+                               .getChildFile ("DemoRunner" + getPlatformSpecificFileExtension());
 
-    extension = {};
+   #if JUCE_MAC
+    if (prebuiltFile.exists())
+   #else
+    if (prebuiltFile.existsAsFile())
    #endif
+        return prebuiltFile;
 
-    auto juceDir = getAppSettings().getStoredPath (Ids::jucePath).toString();
+    return {};
+}
 
-    if (juceDir.isNotEmpty())
+void ProjucerApplication::checkIfGlobalJUCEPathHasChanged()
+{
+    auto globalJUCEPath = File (getAppSettings().getStoredPath (Ids::jucePath, TargetOS::getThisOS()).get());
+
+    if (lastJUCEPath != globalJUCEPath)
     {
-        auto precompiledFile = File (juceDir).getChildFile ("DemoRunner" + extension);
+        hasScannedForDemoRunnerProject = false;
+        hasScannedForDemoRunnerExecutable = false;
 
-       #if JUCE_MAC
-        if (precompiledFile.exists())
-       #else
-        if (precompiledFile.existsAsFile())
-       #endif
-            return precompiledFile;
+        lastJUCEPath = globalJUCEPath;
     }
+}
 
+File ProjucerApplication::tryToFindDemoRunnerExecutable()
+{
+    checkIfGlobalJUCEPathHasChanged();
 
-    return {};
+    if (hasScannedForDemoRunnerExecutable)
+        return lastDemoRunnerExectuableFile;
+
+    auto demoRunnerExecutable = tryToFindDemoRunnerExecutableInBuilds();
+
+    if (demoRunnerExecutable == File())
+        demoRunnerExecutable = tryToFindPrebuiltDemoRunnerExecutable();
+
+    hasScannedForDemoRunnerExecutable = true;
+    lastDemoRunnerExectuableFile = demoRunnerExecutable;
+
+    return demoRunnerExecutable;
 }
 
-File ProjucerApplication::findDemoRunnerProject() noexcept
+File ProjucerApplication::tryToFindDemoRunnerProject()
 {
-    auto buildsPath = getJUCEExamplesDirectoryPathFromGlobal().getChildFile ("DemoRunner").getChildFile ("Builds");
+    checkIfGlobalJUCEPathHasChanged();
 
-    if (! buildsPath.exists())
-        return {};
+    if (hasScannedForDemoRunnerProject)
+        return lastDemoRunnerProjectFile;
 
-   #if JUCE_MAC
-    auto file = buildsPath.getChildFile ("MacOSX").getChildFile ("DemoRunner.xcodeproj");
+    auto projectFolder = getPlatformSpecificProjectFolder();
 
-    if (file.exists())
-        return file;
+   #if JUCE_MAC
+    auto demoRunnerProjectFile = projectFolder.getChildFile ("DemoRunner.xcodeproj");
    #elif JUCE_WINDOWS
-    auto file = buildsPath.getChildFile ("VisualStudio2017").getChildFile ("DemoRunner.sln");
-
-    if (file.existsAsFile())
-        return file;
+    auto demoRunnerProjectFile = projectFolder.getChildFile ("DemoRunner.sln");
    #elif JUCE_LINUX
-    auto file = buildsPath.getChildFile ("LinuxMakeFile").getChildFile ("Makefile");
+    auto demoRunnerProjectFile = projectFolder.getChildFile ("Makefile");
+   #endif
 
-    if (file.existsAsFile())
-        return file;
+   #if JUCE_MAC
+    if (! demoRunnerProjectFile.exists())
+   #else
+    if (! demoRunnerProjectFile.existsAsFile())
    #endif
+        demoRunnerProjectFile = File();
 
-    return {};
+    hasScannedForDemoRunnerProject = true;
+    lastDemoRunnerProjectFile = demoRunnerProjectFile;
+
+    return demoRunnerProjectFile;
 }
 
 void ProjucerApplication::launchDemoRunner()
 {
-    if (findDemoRunnerExecutable() != File())
-    {
-        bool succeeded = true;
+    auto demoRunnerFile = tryToFindDemoRunnerExecutable();
 
-        if (! findDemoRunnerExecutable().startAsProcess())
-        {
-            AlertWindow::showMessageBoxAsync (AlertWindow::WarningIcon, "Error", "There was an error opening the Demo Runner file.");
-            succeeded = false;
-        }
+    if (demoRunnerFile != File())
+    {
+        auto succeeded = demoRunnerFile.startAsProcess();
 
         StringPairArray data;
         data.set ("label", succeeded ? "Success" : "Failure");
 
         Analytics::getInstance()->logEvent ("Launch DemoRunner", data, ProjucerAnalyticsEvent::exampleEvent);
+
+        if (succeeded)
+            return;
     }
-    else if (findDemoRunnerProject() != File())
+
+    demoRunnerFile = tryToFindDemoRunnerProject();
+
+    if (demoRunnerFile != File())
     {
         auto& lf = Desktop::getInstance().getDefaultLookAndFeel();
+
         demoRunnerAlert.reset (lf.createAlertWindow ("Open Project",
                                                      "Couldn't find a compiled version of the Demo Runner."
                                                     #if JUCE_LINUX
@@ -825,7 +897,7 @@ void ProjucerApplication::launchDemoRunner()
                                                      AlertWindow::QuestionIcon, 2,
                                                      mainWindowList.getFrontmostWindow (false)));
 
-        demoRunnerAlert->enterModalState (true, ModalCallbackFunction::create ([this] (int retVal)
+        demoRunnerAlert->enterModalState (true, ModalCallbackFunction::create ([this, demoRunnerFile] (int retVal)
                                                 {
                                                     demoRunnerAlert.reset (nullptr);
 
@@ -836,25 +908,20 @@ void ProjucerApplication::launchDemoRunner()
 
                                                     if (retVal == 1)
                                                     {
-                                                        auto projectFile = findDemoRunnerProject();
-
                                                        #if JUCE_LINUX
-                                                        String command ("make -C " + projectFile.getParentDirectory().getFullPathName() + " CONFIG=Release -j3");
+                                                        String command ("make -C " + demoRunnerFile.getParentDirectory().getFullPathName() + " CONFIG=Release -j3");
 
                                                         if (! makeProcess.start (command))
                                                             AlertWindow::showMessageBoxAsync (AlertWindow::WarningIcon, "Error", "Error building Demo Runner.");
                                                        #else
-                                                        projectFile.startAsProcess();
+                                                        demoRunnerFile.startAsProcess();
                                                        #endif
                                                     }
                                                 }), false);
     }
-    else
-    {
-        jassertfalse;
-    }
 }
 
+//==========================================================================
 void ProjucerApplication::handleMainMenuCommand (int menuItemID)
 {
     if (menuItemID >= recentProjectsBaseID && menuItemID < (recentProjectsBaseID + 100))
@@ -958,8 +1025,8 @@ void ProjucerApplication::getCommandInfo (CommandID commandID, ApplicationComman
         else
        #endif
         {
-        result.setInfo ("Launch Demo Runner", "Launches the JUCE demo runner application, or the project if it can't be found", CommandCategories::general, 0);
-        result.setActive (findDemoRunnerExecutable() != File() || findDemoRunnerProject() != File());
+            result.setInfo ("Launch Demo Runner", "Launches the JUCE demo runner application, or the project if it can't be found", CommandCategories::general, 0);
+            result.setActive (tryToFindDemoRunnerExecutable() != File() || tryToFindDemoRunnerProject() != File());
         }
         break;
 
@@ -1353,14 +1420,6 @@ void ProjucerApplication::initCommandManager()
     registerGUIEditorCommands();
 }
 
-void ProjucerApplication::deleteTemporaryFiles() const noexcept
-{
-    auto tempDirectory = File::getSpecialLocation (File::SpecialLocationType::tempDirectory).getChildFile ("PIPs");
-
-    if (tempDirectory.exists())
-        tempDirectory.deleteRecursively();
-}
-
 void ProjucerApplication::setAnalyticsEnabled (bool enabled)
 {
     resetAnalytics();
@@ -1420,7 +1479,10 @@ void ProjucerApplication::showSetJUCEPathAlert()
 
 void ProjucerApplication::rescanJUCEPathModules()
 {
-    File jucePath (getAppSettings().getStoredPath (Ids::defaultJuceModulePath).toString());
+    File jucePath (getAppSettings().getStoredPath (Ids::defaultJuceModulePath, TargetOS::getThisOS()).get().toString());
+
+    if (! jucePath.exists())
+        return;
 
     if (isRunningCommandLine)
         jucePathModuleList.scanPaths ({ jucePath });
@@ -1432,7 +1494,7 @@ static Array<File> getSanitisedUserModulePaths()
 {
     Array<File> paths;
 
-    for (auto p : StringArray::fromTokens (getAppSettings().getStoredPath (Ids::defaultUserModulePath).toString(), ";", {}))
+    for (auto p : StringArray::fromTokens (getAppSettings().getStoredPath (Ids::defaultUserModulePath, TargetOS::getThisOS()).get().toString(), ";", {}))
     {
         p = p.replace ("~", File::getSpecialLocation (File::userHomeDirectory).getFullPathName());
         paths.add (File::createFileWithoutCheckingPath (p.trim()));

extras/Projucer/Source/Application/jucer_Application.h

@@ -169,58 +169,49 @@ public:
     std::unique_ptr<LicenseController> licenseController;
 
 private:
-    void* server = nullptr;
-
-    std::unique_ptr<LatestVersionChecker> versionChecker;
-    TooltipWindow tooltipWindow;
-
-    void loginOrLogout();
-
-    bool checkEULA();
-    bool currentEULAHasBeenAcceptedPreviously() const;
-    String getEULAChecksumProperty() const;
-    void setCurrentEULAAccepted (bool hasBeenAccepted) const;
-
+    //==============================================================================
     void handleAsyncUpdate() override;
     void initCommandManager();
 
-    void deleteTemporaryFiles() const noexcept;
-
     void createExamplesPopupMenu (PopupMenu&) noexcept;
     Array<File> getSortedExampleDirectories() noexcept;
     Array<File> getSortedExampleFilesInDirectory (const File&) const noexcept;
-
     bool findWindowAndOpenPIP (const File&);
-
-    File getJUCEExamplesDirectoryPathFromGlobal() noexcept;
     void findAndLaunchExample (int);
-    File findDemoRunnerExecutable() noexcept;
-    File findDemoRunnerProject() noexcept;
-    void launchDemoRunner();
-
-    int numExamples = 0;
-    std::unique_ptr<AlertWindow> demoRunnerAlert;
 
-   #if JUCE_LINUX
-    ChildProcess makeProcess;
-   #endif
+    void checkIfGlobalJUCEPathHasChanged();
+    File tryToFindDemoRunnerExecutable();
+    File tryToFindDemoRunnerProject();
+    void launchDemoRunner();
 
     void resetAnalytics() noexcept;
     void setupAnalytics();
 
     void showSetJUCEPathAlert();
-    std::unique_ptr<AlertWindow> pathAlert;
 
-    AvailableModuleList jucePathModuleList, userPathsModuleList;
-
-    //==============================================================================
     void setColourScheme (int index, bool saveSetting);
-
     void setEditorColourScheme (int index, bool saveSetting);
     void updateEditorColourSchemeIfNeeded();
 
-    int selectedColourSchemeIndex = 0;
+    //==============================================================================
+    void* server = nullptr;
+
+    std::unique_ptr<LatestVersionChecker> versionChecker;
+    TooltipWindow tooltipWindow;
+
+    AvailableModuleList jucePathModuleList, userPathsModuleList;
+
+    int numExamples = 0;
+    std::unique_ptr<AlertWindow> demoRunnerAlert;
+    std::unique_ptr<AlertWindow> pathAlert;
+    bool hasScannedForDemoRunnerExecutable = false, hasScannedForDemoRunnerProject = false;
+    File lastJUCEPath, lastDemoRunnerExectuableFile, lastDemoRunnerProjectFile;
+   #if JUCE_LINUX
+    ChildProcess makeProcess;
+   #endif
 
-    int selectedEditorColourSchemeIndex = 0;
-    int numEditorColourSchemes = 0;
+    int selectedColourSchemeIndex = 0, selectedEditorColourSchemeIndex = 0, numEditorColourSchemes = 0;
+
+    //==============================================================================
+    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProjucerApplication)
 };