DISTRHO
/
JUCE
mirror of https://github.com/DISTRHO/JUCE
1
0
Fork 0
Code Releases 1 Activity
The JUCE cross-platform C++ framework, with DISTRHO/KXStudio specific changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10939 Commits
9 Branches
1.8GB
Tree: 521c250413
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '521c250413'
${ noResults }
JUCE/extras/Projucer/Source/ProjectSaving/jucer_ProjectSaver.h

832 lines
30KB
Raw Blame History 

  1. /*

  2.   ==============================================================================

  3. 

  4.    This file is part of the JUCE 6 technical preview.

  5.    Copyright (c) 2017 - ROLI Ltd.

  6. 

  7.    You may use this code under the terms of the GPL v3

  8.    (see www.gnu.org/licenses).

  9. 

  10.    For this technical preview, this file is not subject to commercial licensing.

  11. 

  12.    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER

  13.    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE

  14.    DISCLAIMED.

  15. 

  16.   ==============================================================================

  17. */

  18. 

  19. #pragma once

  20. 

  21. #include "jucer_ResourceFile.h"

  22. #include "../Project/jucer_Module.h"

  23. #include "jucer_ProjectExporter.h"

  24. 

  25. //==============================================================================

  26. class ProjectSaver

  27. {

  28. public:

  29.     ProjectSaver (Project& p, const File& file)

  30.         : project (p),

  31.           projectFile (file),

  32.           generatedCodeFolder (project.getGeneratedCodeFolder()),

  33.           generatedFilesGroup (Project::Item::createGroup (project, getJuceCodeGroupName(), "__generatedcode__", true))

  34.     {

  35.         generatedFilesGroup.setID (getGeneratedGroupID());

  36.     }

  37. 

  38.     struct SaveThread  : public ThreadWithProgressWindow

  39.     {

  40.     public:

  41.         SaveThread (ProjectSaver& ps, bool wait, const String& exp)

  42.             : ThreadWithProgressWindow ("Saving...", true, false),

  43.               saver (ps),

  44.               shouldWaitAfterSaving (wait),

  45.               specifiedExporterToSave (exp)

  46.         {}

  47. 

  48.         void run() override

  49.         {

  50.             setProgress (-1);

  51.             result = saver.save (false, shouldWaitAfterSaving, specifiedExporterToSave);

  52.         }

  53. 

  54.         ProjectSaver& saver;

  55.         Result result = Result::ok();

  56.         bool shouldWaitAfterSaving;

  57.         String specifiedExporterToSave;

  58. 

  59.         JUCE_DECLARE_NON_COPYABLE (SaveThread)

  60.     };

  61. 

  62.     Result save (bool showProgressBox, bool waitAfterSaving, const String& specifiedExporterToSave)

  63.     {

  64.         if (showProgressBox)

  65.         {

  66.             SaveThread thread (*this, waitAfterSaving, specifiedExporterToSave);

  67.             thread.runThread();

  68.             return thread.result;

  69.         }

  70. 

  71.         projectLineFeed = project.getProjectLineFeed();

  72. 

  73.         auto appConfigUserContent = loadUserContentFromAppConfig();

  74. 

  75.         auto oldFile = project.getFile();

  76.         project.setFile (projectFile);

  77. 

  78.         OwnedArray<LibraryModule> modules;

  79.         project.getEnabledModules().createRequiredModules (modules);

  80. 

  81.         checkModuleValidity (modules);

  82. 

  83.         if (errors.size() == 0)

  84.         {

  85.             writeMainProjectFile();

  86.             project.updateModificationTime();

  87. 

  88.             auto projectRootHash = project.getProjectRoot().toXmlString().hashCode();

  89. 

  90.             if (project.isAudioPluginProject())

  91.             {

  92.                 if (project.shouldBuildUnityPlugin())

  93.                     writeUnityScriptFile();

  94.             }

  95. 

  96.             saveBasicProjectItems (modules, appConfigUserContent);

  97.             writeProjects (modules, specifiedExporterToSave, ! showProgressBox);

  98.             runPostExportScript();

  99. 

  100.             // if the project root has changed after writing the other files then re-save it

  101.             if (project.getProjectRoot().toXmlString().hashCode() != projectRootHash)

  102.             {

  103.                 writeMainProjectFile();

  104.                 project.updateModificationTime();

  105.             }

  106. 

  107.             if (generatedCodeFolder.exists())

  108.             {

  109.                 writeReadmeFile();

  110.                 deleteUnwantedFilesIn (generatedCodeFolder);

  111.             }

  112. 

  113.             if (errors.size() == 0)

  114.             {

  115.                 // Workaround for a bug where Xcode thinks the project is invalid if opened immediately

  116.                 // after writing

  117.                 if (waitAfterSaving)

  118.                     Thread::sleep (2000);

  119. 

  120.                 return Result::ok();

  121.             }

  122.         }

  123. 

  124.         project.setFile (oldFile);

  125.         return Result::fail (errors[0]);

  126.     }

  127. 

  128.     Result saveResourcesOnly()

  129.     {

  130.         writeBinaryDataFiles();

  131. 

  132.         if (errors.size() > 0)

  133.             return Result::fail (errors[0]);

  134. 

  135.         return Result::ok();

  136.     }

  137. 

  138.     void saveBasicProjectItems (const OwnedArray<LibraryModule>& modules, const String& appConfigUserContent)

  139.     {

  140.         writePluginDefines();

  141.         writeAppConfigFile (modules, appConfigUserContent);

  142.         writeBinaryDataFiles();

  143.         writeAppHeader (modules);

  144.         writeModuleCppWrappers (modules);

  145.     }

  146. 

  147.     Result saveContentNeededForLiveBuild()

  148.     {

  149.         OwnedArray<LibraryModule> modules;

  150.         project.getEnabledModules().createRequiredModules (modules);

  151. 

  152.         checkModuleValidity (modules);

  153. 

  154.         if (errors.size() == 0)

  155.         {

  156.             saveBasicProjectItems (modules, loadUserContentFromAppConfig());

  157. 

  158.             return Result::ok();

  159.         }

  160. 

  161.         return Result::fail (errors[0]);

  162.     }

  163. 

  164.     Project::Item saveGeneratedFile (const String& filePath, const MemoryOutputStream& newData)

  165.     {

  166.         if (! generatedCodeFolder.createDirectory())

  167.         {

  168.             addError ("Couldn't create folder: " + generatedCodeFolder.getFullPathName());

  169.             return Project::Item (project, ValueTree(), false);

  170.         }

  171. 

  172.         auto file = generatedCodeFolder.getChildFile (filePath);

  173. 

  174.         if (replaceFileIfDifferent (file, newData))

  175.             return addFileToGeneratedGroup (file);

  176. 

  177.         return { project, {}, true };

  178.     }

  179. 

  180.     Project::Item addFileToGeneratedGroup (const File& file)

  181.     {

  182.         auto item = generatedFilesGroup.findItemForFile (file);

  183. 

  184.         if (item.isValid())

  185.             return item;

  186. 

  187.         generatedFilesGroup.addFileAtIndex (file, -1, true);

  188.         return generatedFilesGroup.findItemForFile (file);

  189.     }

  190. 

  191.     static void writeAutoGenWarningComment (OutputStream& out)

  192.     {

  193.         out << "/*" << newLine << newLine

  194.             << "    IMPORTANT! This file is auto-generated each time you save your" << newLine

  195.             << "    project - if you alter its contents, your changes may be overwritten!" << newLine

  196.             << newLine;

  197.     }

  198. 

  199.     static const char* getGeneratedGroupID() noexcept               { return "__jucelibfiles"; }

  200.     Project::Item& getGeneratedCodeGroup()                          { return generatedFilesGroup; }

  201. 

  202.     static String getJuceCodeGroupName()                            { return "JUCE Library Code"; }

  203. 

  204.     File getGeneratedCodeFolder() const                             { return generatedCodeFolder; }

  205. 

  206.     bool replaceFileIfDifferent (const File& f, const MemoryOutputStream& newData)

  207.     {

  208.         filesCreated.add (f);

  209. 

  210.         if (!build_tools::overwriteFileWithNewDataIfDifferent (f, newData))

  211.         {

  212.             addError ("Can't write to file: " + f.getFullPathName());

  213.             return false;

  214.         }

  215. 

  216.         return true;

  217.     }

  218. 

  219.     static bool shouldFolderBeIgnoredWhenCopying (const File& f)

  220.     {

  221.         return f.getFileName() == ".git" || f.getFileName() == ".svn" || f.getFileName() == ".cvs";

  222.     }

  223. 

  224.     bool copyFolder (const File& source, const File& dest)

  225.     {

  226.         if (source.isDirectory() && dest.createDirectory())

  227.         {

  228.             for (auto& f : source.findChildFiles (File::findFiles, false))

  229.             {

  230.                 auto target = dest.getChildFile (f.getFileName());

  231.                 filesCreated.add (target);

  232. 

  233.                 if (! f.copyFileTo (target))

  234.                     return false;

  235.             }

  236. 

  237.             for (auto& f : source.findChildFiles (File::findDirectories, false))

  238.                 if (! shouldFolderBeIgnoredWhenCopying (f))

  239.                     if (! copyFolder (f, dest.getChildFile (f.getFileName())))

  240.                         return false;

  241. 

  242.             return true;

  243.         }

  244. 

  245.         return false;

  246.     }

  247. 

  248.     Project& project;

  249.     SortedSet<File> filesCreated;

  250. 

  251. private:

  252.     const File projectFile, generatedCodeFolder;

  253.     Project::Item generatedFilesGroup;

  254.     StringArray errors;

  255.     CriticalSection errorLock;

  256. 

  257.     bool hasBinaryData = false;

  258.     String projectLineFeed = "\r\n";

  259. 

  260.     // Recursively clears out any files in a folder that we didn't create, but avoids

  261.     // any folders containing hidden files that might be used by version-control systems.

  262.     bool deleteUnwantedFilesIn (const File& parent)

  263.     {

  264.         bool folderIsNowEmpty = true;

  265.         Array<File> filesToDelete;

  266. 

  267.         for (const auto& i : RangedDirectoryIterator (parent, false, "*", File::findFilesAndDirectories))

  268.         {

  269.             auto f = i.getFile();

  270. 

  271.             if (filesCreated.contains (f) || shouldFileBeKept (f.getFileName()))

  272.             {

  273.                 folderIsNowEmpty = false;

  274.             }

  275.             else if (i.isDirectory())

  276.             {

  277.                 if (deleteUnwantedFilesIn (f))

  278.                     filesToDelete.add (f);

  279.                 else

  280.                     folderIsNowEmpty = false;

  281.             }

  282.             else

  283.             {

  284.                 filesToDelete.add (f);

  285.             }

  286.         }

  287. 

  288.         for (int j = filesToDelete.size(); --j >= 0;)

  289.             filesToDelete.getReference(j).deleteRecursively();

  290. 

  291.         return folderIsNowEmpty;

  292.     }

  293. 

  294.     static bool shouldFileBeKept (const String& filename)

  295.     {

  296.         static const char* filesToKeep[] = { ".svn", ".cvs", "CMakeLists.txt" };

  297. 

  298.         for (auto* f : filesToKeep)

  299.             if (filename == f)

  300.                 return true;

  301. 

  302.         return false;

  303.     }

  304. 

  305.     void writeMainProjectFile()

  306.     {

  307.         if (auto xml = project.getProjectRoot().createXml())

  308.         {

  309.             XmlElement::TextFormat format;

  310.             format.newLineChars = projectLineFeed.toRawUTF8();

  311. 

  312.             MemoryOutputStream mo (8192);

  313.             xml->writeTo (mo, format);

  314.             replaceFileIfDifferent (projectFile, mo);

  315.         }

  316.         else

  317.         {

  318.             jassertfalse;

  319.         }

  320.     }

  321. 

  322.     static int findLongestModuleName (const OwnedArray<LibraryModule>& modules)

  323.     {

  324.         int longest = 0;

  325. 

  326.         for (auto& m : modules)

  327.             longest = jmax (longest, m->getID().length());

  328. 

  329.         return longest;

  330.     }

  331. 

  332.     File getAppConfigFile() const     { return generatedCodeFolder.getChildFile (Project::getAppConfigFilename()); }

  333.     File getPluginDefinesFile() const { return generatedCodeFolder.getChildFile (Project::getPluginDefinesFilename()); }

  334. 

  335.     String loadUserContentFromAppConfig() const

  336.     {

  337.         StringArray userContent;

  338.         bool foundCodeSection = false;

  339.         auto lines = StringArray::fromLines (getAppConfigFile().loadFileAsString());

  340. 

  341.         for (int i = 0; i < lines.size(); ++i)

  342.         {

  343.             if (lines[i].contains ("[BEGIN_USER_CODE_SECTION]"))

  344.             {

  345.                 for (int j = i + 1; j < lines.size() && ! lines[j].contains ("[END_USER_CODE_SECTION]"); ++j)

  346.                     userContent.add (lines[j]);

  347. 

  348.                 foundCodeSection = true;

  349.                 break;

  350.             }

  351.         }

  352. 

  353.         if (! foundCodeSection)

  354.         {

  355.             userContent.add ({});

  356.             userContent.add ("// (You can add your own code in this section, and the Projucer will not overwrite it)");

  357.             userContent.add ({});

  358.         }

  359. 

  360.         return userContent.joinIntoString (projectLineFeed) + projectLineFeed;

  361.     }

  362. 

  363.     void checkModuleValidity (OwnedArray<LibraryModule>& modules)

  364.     {

  365.         if (project.getNumExporters() == 0)

  366.         {

  367.             addError ("No exporters found!\n"

  368.                       "Please add an exporter before saving.");

  369.             return;

  370.         }

  371. 

  372.         for (auto moduleIter = modules.begin(); moduleIter != modules.end(); ++moduleIter)

  373.         {

  374.             if (auto* module = *moduleIter)

  375.             {

  376.                 if (! module->isValid())

  377.                 {

  378.                     addError ("At least one of your JUCE module paths is invalid!\n"

  379.                               "Please go to the Modules settings page and ensure each path points to the correct JUCE modules folder.");

  380.                     return;

  381.                 }

  382. 

  383.                 if (project.getEnabledModules().getExtraDependenciesNeeded (module->getID()).size() > 0)

  384.                 {

  385.                     addError ("At least one of your modules has missing dependencies!\n"

  386.                               "Please go to the settings page of the highlighted modules and add the required dependencies.");

  387.                     return;

  388.                 }

  389.             }

  390.             else

  391.             {

  392.                 // this should never happen!

  393.                 jassertfalse;

  394.             }

  395.         }

  396.     }

  397. 

  398.     void writePluginDefines (MemoryOutputStream& out) const

  399.     {

  400.         const auto pluginDefines = getAudioPluginDefines();

  401. 

  402.         if (pluginDefines.isEmpty())

  403.             return;

  404. 

  405.         writeAutoGenWarningComment (out);

  406.         out << "*/" << newLine << newLine

  407.             << "#pragma once" << newLine << newLine

  408.             << pluginDefines << newLine;

  409.     }

  410. 

  411.     void writeAppConfig (MemoryOutputStream& out, const OwnedArray<LibraryModule>& modules, const String& userContent)

  412.     {

  413.         if (! project.shouldUseAppConfig())

  414.             return;

  415. 

  416.         writeAutoGenWarningComment (out);

  417.         out << "    There's a section below where you can add your own custom code safely, and the" << newLine

  418.             << "    Projucer will preserve the contents of that block, but the best way to change" << newLine

  419.             << "    any of these definitions is by using the Projucer's project settings." << newLine

  420.             << newLine

  421.             << "    Any commented-out settings will assume their default values." << newLine

  422.             << newLine

  423.             << "*/" << newLine

  424.             << newLine;

  425. 

  426.         out << "#pragma once" << newLine

  427.             << newLine

  428.             << "//==============================================================================" << newLine

  429.             << "// [BEGIN_USER_CODE_SECTION]" << newLine

  430.             << userContent

  431.             << "// [END_USER_CODE_SECTION]" << newLine;

  432. 

  433.         if (getPluginDefinesFile().existsAsFile() && getAudioPluginDefines().isNotEmpty())

  434.             out << newLine << CodeHelpers::createIncludeStatement (Project::getPluginDefinesFilename()) << newLine;

  435. 

  436.         out << newLine

  437.             << "/*" << newLine

  438.             << "  ==============================================================================" << newLine

  439.             << newLine

  440.             << "   In accordance with the terms of the JUCE 5 End-Use License Agreement, the" << newLine

  441.             << "   JUCE Code in SECTION A cannot be removed, changed or otherwise rendered" << newLine

  442.             << "   ineffective unless you have a JUCE Indie or Pro license, or are using JUCE" << newLine

  443.             << "   under the GPL v3 license." << newLine

  444.             << newLine

  445.             << "   End User License Agreement: www.juce.com/juce-5-licence" << newLine

  446.             << newLine

  447.             << "  ==============================================================================" << newLine

  448.             << "*/" << newLine

  449.             << newLine

  450.             << "// BEGIN SECTION A" << newLine

  451.             << newLine

  452.             << "#ifndef JUCE_DISPLAY_SPLASH_SCREEN" << newLine

  453.             << " #define JUCE_DISPLAY_SPLASH_SCREEN "   << (project.shouldDisplaySplashScreen() ? "1" : "0") << newLine

  454.             << "#endif" << newLine << newLine

  455. 

  456.             << "#ifndef JUCE_REPORT_APP_USAGE" << newLine

  457.             << " #define JUCE_REPORT_APP_USAGE "        << (project.shouldReportAppUsage()      ? "1" : "0") << newLine

  458.             << "#endif" << newLine

  459.             << newLine

  460.             << "// END SECTION A" << newLine

  461.             << newLine

  462.             << "#define JUCE_USE_DARK_SPLASH_SCREEN "  << (project.getSplashScreenColourString() == "Dark" ? "1" : "0") << newLine

  463.             << newLine

  464.             << "#define JUCE_PROJUCER_VERSION 0x" << String::toHexString (ProjectInfo::versionNumber) << newLine;

  465. 

  466.         out << newLine

  467.             << "//==============================================================================" << newLine;

  468. 

  469.         auto longestName = findLongestModuleName (modules);

  470. 

  471.         for (auto& m : modules)

  472.             out << "#define JUCE_MODULE_AVAILABLE_" << m->getID()

  473.                 << String::repeatedString (" ", longestName + 5 - m->getID().length()) << " 1" << newLine;

  474. 

  475.         out << newLine << "#define JUCE_GLOBAL_MODULE_SETTINGS_INCLUDED 1" << newLine;

  476. 

  477.         for (auto& m : modules)

  478.         {

  479.             OwnedArray<Project::ConfigFlag> flags;

  480.             m->getConfigFlags (project, flags);

  481. 

  482.             if (flags.size() > 0)

  483.             {

  484.                 out << newLine

  485.                     << "//==============================================================================" << newLine

  486.                     << "// " << m->getID() << " flags:" << newLine;

  487. 

  488.                 for (auto* flag : flags)

  489.                 {

  490.                     out << newLine

  491.                     << "#ifndef    " << flag->symbol

  492.                     << newLine

  493.                     << (flag->value.isUsingDefault() ? " //#define " : " #define   ") << flag->symbol << " " << (flag->value.get() ? "1" : "0")

  494.                     << newLine

  495.                     << "#endif"

  496.                     << newLine;

  497.                 }

  498.             }

  499.         }

  500. 

  501.         {

  502.             auto& type = project.getProjectType();

  503. 

  504.             auto isStandaloneApplication = (! type.isAudioPlugin() && ! type.isDynamicLibrary());

  505. 

  506.             out << newLine

  507.                 << "//==============================================================================" << newLine

  508.                 << "#ifndef    JUCE_STANDALONE_APPLICATION" << newLine

  509.                 << " #if defined(JucePlugin_Name) && defined(JucePlugin_Build_Standalone)" << newLine

  510.                 << "  #define  JUCE_STANDALONE_APPLICATION JucePlugin_Build_Standalone" << newLine

  511.                 << " #else" << newLine

  512.                 << "  #define  JUCE_STANDALONE_APPLICATION " << (isStandaloneApplication ? "1" : "0") << newLine

  513.                 << " #endif" << newLine

  514.                 << "#endif" << newLine;

  515.         }

  516.     }

  517. 

  518.     template <typename WriterCallback>

  519.     void writeOrRemoveGeneratedFile (const String& name, WriterCallback&& writerCallback)

  520.     {

  521.         MemoryOutputStream mem;

  522.         mem.setNewLineString (projectLineFeed);

  523. 

  524.         writerCallback (mem);

  525. 

  526.         if (mem.getDataSize() != 0)

  527.         {

  528.             saveGeneratedFile (name, mem);

  529.             return;

  530.         }

  531. 

  532.         const auto destFile = generatedCodeFolder.getChildFile (name);

  533. 

  534.         if (destFile.existsAsFile())

  535.         {

  536.             if (! destFile.deleteFile())

  537.                 addError ("Couldn't remove unnecessary file: " + destFile.getFullPathName());

  538.         }

  539.     }

  540. 

  541.     void writePluginDefines()

  542.     {

  543.         writeOrRemoveGeneratedFile (Project::getPluginDefinesFilename(), [&] (MemoryOutputStream& mem)

  544.         {

  545.             writePluginDefines (mem);

  546.         });

  547.     }

  548. 

  549.     void writeAppConfigFile (const OwnedArray<LibraryModule>& modules, const String& userContent)

  550.     {

  551.         writeOrRemoveGeneratedFile (Project::getAppConfigFilename(), [&] (MemoryOutputStream& mem)

  552.         {

  553.             writeAppConfig (mem, modules, userContent);

  554.         });

  555.     }

  556. 

  557.     void writeAppHeader (MemoryOutputStream& out, const OwnedArray<LibraryModule>& modules)

  558.     {

  559.         writeAutoGenWarningComment (out);

  560. 

  561.         out << "    This is the header file that your files should include in order to get all the" << newLine

  562.             << "    JUCE library headers. You should avoid including the JUCE headers directly in" << newLine

  563.             << "    your own source files, because that wouldn't pick up the correct configuration" << newLine

  564.             << "    options for your app." << newLine

  565.             << newLine

  566.             << "*/" << newLine << newLine;

  567. 

  568.         out << "#pragma once" << newLine << newLine;

  569. 

  570.         if (getAppConfigFile().exists() && project.shouldUseAppConfig())

  571.             out << CodeHelpers::createIncludeStatement (Project::getAppConfigFilename()) << newLine;

  572. 

  573.         if (modules.size() > 0)

  574.         {

  575.             out << newLine;

  576. 

  577.             for (int i = 0; i < modules.size(); ++i)

  578.                 modules.getUnchecked(i)->writeIncludes (*this, out);

  579. 

  580.             out << newLine;

  581.         }

  582. 

  583.         if (hasBinaryData && project.shouldIncludeBinaryInJuceHeader())

  584.             out << CodeHelpers::createIncludeStatement (project.getBinaryDataHeaderFile(), getAppConfigFile()) << newLine;

  585. 

  586.         out << newLine

  587.             << "#if defined (JUCE_PROJUCER_VERSION) && JUCE_PROJUCER_VERSION < JUCE_VERSION" << newLine

  588.             << " /** If you've hit this error then the version of the Projucer that was used to generate this project is" << newLine

  589.             << "     older than the version of the JUCE modules being included. To fix this error, re-save your project" << newLine

  590.             << "     using the latest version of the Projucer or, if you aren't using the Projucer to manage your project," << newLine

  591.             << "     remove the JUCE_PROJUCER_VERSION define from the AppConfig.h file." << newLine

  592.             << " */" << newLine

  593.             << " #error \"This project was last saved using an outdated version of the Projucer! Re-save this project with the latest version to fix this error.\"" << newLine

  594.             << "#endif" << newLine

  595.             << newLine;

  596. 

  597.         if (project.shouldAddUsingNamespaceToJuceHeader())

  598.             out << "#if ! DONT_SET_USING_JUCE_NAMESPACE" << newLine

  599.                 << " // If your code uses a lot of JUCE classes, then this will obviously save you" << newLine

  600.                 << " // a lot of typing, but can be disabled by setting DONT_SET_USING_JUCE_NAMESPACE." << newLine

  601.                 << " using namespace juce;" << newLine

  602.                 << "#endif" << newLine

  603.                 << newLine;

  604. 

  605.         out << "#if ! JUCE_DONT_DECLARE_PROJECTINFO" << newLine

  606.             << "namespace ProjectInfo" << newLine

  607.             << "{" << newLine

  608.             << "    const char* const  projectName    = " << CppTokeniserFunctions::addEscapeChars (project.getProjectNameString()).quoted() << ";" << newLine

  609.             << "    const char* const  companyName    = " << CppTokeniserFunctions::addEscapeChars (project.getCompanyNameString()).quoted() << ";" << newLine

  610.             << "    const char* const  versionString  = " << CppTokeniserFunctions::addEscapeChars (project.getVersionString()).quoted() << ";" << newLine

  611.             << "    const int          versionNumber  = " << project.getVersionAsHex() << ";" << newLine

  612.             << "}" << newLine

  613.             << "#endif" << newLine;

  614.     }

  615. 

  616.     void writeAppHeader (const OwnedArray<LibraryModule>& modules)

  617.     {

  618.         MemoryOutputStream mem;

  619.         mem.setNewLineString (projectLineFeed);

  620. 

  621.         writeAppHeader (mem, modules);

  622.         saveGeneratedFile (Project::getJuceSourceHFilename(), mem);

  623.     }

  624. 

  625.     void writeModuleCppWrappers (const OwnedArray<LibraryModule>& modules)

  626.     {

  627.         for (auto* module : modules)

  628.         {

  629.             for (auto& cu : module->getAllCompileUnits())

  630.             {

  631.                 MemoryOutputStream mem;

  632.                 mem.setNewLineString (projectLineFeed);

  633. 

  634.                 writeAutoGenWarningComment (mem);

  635. 

  636.                 mem << "*/" << newLine << newLine;

  637. 

  638.                 if (project.shouldUseAppConfig())

  639.                     mem << "#include " << Project::getAppConfigFilename().quoted() << newLine;

  640. 

  641.                 mem << "#include <";

  642. 

  643.                 if (cu.file.getFileExtension() != ".r")   // .r files are included without the path

  644.                     mem << module->getID() << "/";

  645. 

  646.                 mem << cu.file.getFileName() << ">" << newLine;

  647. 

  648.                 replaceFileIfDifferent (generatedCodeFolder.getChildFile (cu.getFilenameForProxyFile()), mem);

  649.             }

  650.         }

  651.     }

  652. 

  653.     void writeBinaryDataFiles()

  654.     {

  655.         auto binaryDataH = project.getBinaryDataHeaderFile();

  656. 

  657.         JucerResourceFile resourceFile (project);

  658. 

  659.         if (resourceFile.getNumFiles() > 0)

  660.         {

  661.             auto dataNamespace = project.getBinaryDataNamespaceString().trim();

  662. 

  663.             if (dataNamespace.isEmpty())

  664.                 dataNamespace = "BinaryData";

  665. 

  666.             resourceFile.setClassName (dataNamespace);

  667. 

  668.             auto maxSize = project.getMaxBinaryFileSize();

  669. 

  670.             if (maxSize <= 0)

  671.                 maxSize = 10 * 1024 * 1024;

  672. 

  673.             auto r = resourceFile.write (maxSize);

  674. 

  675.             if (r.result.wasOk())

  676.             {

  677.                 hasBinaryData = true;

  678. 

  679.                 for (auto& f : r.filesCreated)

  680.                 {

  681.                     filesCreated.add (f);

  682.                     generatedFilesGroup.addFileRetainingSortOrder (f, ! f.hasFileExtension (".h"));

  683.                 }

  684.             }

  685.             else

  686.             {

  687.                 addError (r.result.getErrorMessage());

  688.             }

  689.         }

  690.         else

  691.         {

  692.             for (int i = 20; --i >= 0;)

  693.                 project.getBinaryDataCppFile (i).deleteFile();

  694. 

  695.             binaryDataH.deleteFile();

  696.         }

  697.     }

  698. 

  699.     void writeReadmeFile()

  700.     {

  701.         MemoryOutputStream out;

  702.         out.setNewLineString (projectLineFeed);

  703. 

  704.         out << newLine

  705.             << " Important Note!!" << newLine

  706.             << " ================" << newLine

  707.             << newLine

  708.             << "The purpose of this folder is to contain files that are auto-generated by the Projucer," << newLine

  709.             << "and ALL files in this folder will be mercilessly DELETED and completely re-written whenever" << newLine

  710.             << "the Projucer saves your project." << newLine

  711.             << newLine

  712.             << "Therefore, it's a bad idea to make any manual changes to the files in here, or to" << newLine

  713.             << "put any of your own files in here if you don't want to lose them. (Of course you may choose" << newLine

  714.             << "to add the folder's contents to your version-control system so that you can re-merge your own" << newLine

  715.             << "modifications after the Projucer has saved its changes)." << newLine;

  716. 

  717.         replaceFileIfDifferent (generatedCodeFolder.getChildFile ("ReadMe.txt"), out);

  718.     }

  719. 

  720.     void addError (const String& message)

  721.     {

  722.         const ScopedLock sl (errorLock);

  723.         errors.add (message);

  724.     }

  725. 

  726.     String getAudioPluginDefines() const;

  727. 

  728.     void writeUnityScriptFile()

  729.     {

  730.         auto unityScriptContents = replaceLineFeeds (BinaryData::UnityPluginGUIScript_cs_in,

  731.                                                      projectLineFeed);

  732. 

  733.         auto projectName = Project::addUnityPluginPrefixIfNecessary (project.getProjectNameString());

  734. 

  735.         unityScriptContents = unityScriptContents.replace ("${plugin_class_name}",  projectName.replace (" ", "_"))

  736.                                                  .replace ("${plugin_name}",        projectName)

  737.                                                  .replace ("${plugin_vendor}",      project.getPluginManufacturerString())

  738.                                                  .replace ("${plugin_description}", project.getPluginDescriptionString());

  739. 

  740.         auto f = getGeneratedCodeFolder().getChildFile (project.getUnityScriptName());

  741. 

  742.         MemoryOutputStream out;

  743.         out << unityScriptContents;

  744. 

  745.         replaceFileIfDifferent (f, out);

  746.     }

  747. 

  748.     void writeProjects (const OwnedArray<LibraryModule>&, const String&, bool);

  749. 

  750.     void runPostExportScript()

  751.     {

  752.        #if JUCE_WINDOWS

  753.         auto cmdString = project.getPostExportShellCommandWinString();

  754.        #else

  755.         auto cmdString = project.getPostExportShellCommandPosixString();

  756.        #endif

  757. 

  758.         auto shellCommand = cmdString.replace ("%%1%%", project.getProjectFolder().getFullPathName());

  759. 

  760.         if (shellCommand.isNotEmpty())

  761.         {

  762.            #if JUCE_WINDOWS

  763.             StringArray argList ("cmd.exe", "/c");

  764.            #else

  765.             StringArray argList ("/bin/sh", "-c");

  766.            #endif

  767. 

  768.             argList.add (shellCommand);

  769.             ChildProcess shellProcess;

  770. 

  771.             if (! shellProcess.start (argList))

  772.             {

  773.                 addError ("Failed to run shell command: " + argList.joinIntoString (" "));

  774.                 return;

  775.             }

  776. 

  777.             if (! shellProcess.waitForProcessToFinish (10000))

  778.             {

  779.                 addError ("Timeout running shell command: " + argList.joinIntoString (" "));

  780.                 return;

  781.             }

  782. 

  783.             auto exitCode = shellProcess.getExitCode();

  784. 

  785.             if (exitCode != 0)

  786.                 addError ("Shell command: " + argList.joinIntoString (" ") + " failed with exit code: " + String (exitCode));

  787.         }

  788.     }

  789. 

  790.     void saveExporter (ProjectExporter* exporter, const OwnedArray<LibraryModule>& modules)

  791.     {

  792.         try

  793.         {

  794.             exporter->create (modules);

  795. 

  796.             if (! exporter->isCLion())

  797.                 std::cout << "Finished saving: " << exporter->getName() << std::endl;

  798.         }

  799.         catch (build_tools::SaveError& error)

  800.         {

  801.             addError (error.message);

  802.         }

  803.     }

  804. 

  805.     class ExporterJob   : public ThreadPoolJob

  806.     {

  807.     public:

  808.         ExporterJob (ProjectSaver& ps, ProjectExporter* pe,

  809.                      const OwnedArray<LibraryModule>& moduleList)

  810.             : ThreadPoolJob ("export"),

  811.               owner (ps), exporter (pe), modules (moduleList)

  812.         {

  813.         }

  814. 

  815.         JobStatus runJob() override

  816.         {

  817.             owner.saveExporter (exporter.get(), modules);

  818.             return jobHasFinished;

  819.         }

  820. 

  821.     private:

  822.         ProjectSaver& owner;

  823.         std::unique_ptr<ProjectExporter> exporter;

  824.         const OwnedArray<LibraryModule>& modules;

  825. 

  826.         JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ExporterJob)

  827.     };

  828. 

  829. 

  830.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProjectSaver)

  831. };