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.

1577 lines
57KB

  1. /*
  2. ==============================================================================
  3. This file is part of the JUCE library.
  4. Copyright (c) 2017 - ROLI Ltd.
  5. JUCE is an open source library subject to commercial or open-source
  6. licensing.
  7. By using JUCE, you agree to the terms of both the JUCE 5 End-User License
  8. Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
  9. 27th April 2017).
  10. End User License Agreement: www.juce.com/juce-5-licence
  11. Privacy Policy: www.juce.com/juce-5-privacy-policy
  12. Or: You may also use this code under the terms of the GPL v3 (see
  13. www.gnu.org/licenses).
  14. JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  15. EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  16. DISCLAIMED.
  17. ==============================================================================
  18. */
  19. #include "../Application/jucer_Headers.h"
  20. #include "jucer_Project.h"
  21. #include "../ProjectSaving/jucer_ProjectSaver.h"
  22. #include "../Application/jucer_Application.h"
  23. namespace
  24. {
  25. String makeValid4CC (const String& seed)
  26. {
  27. String s (CodeHelpers::makeValidIdentifier (seed, false, true, false) + "xxxx");
  28. return s.substring (0, 1).toUpperCase()
  29. + s.substring (1, 4).toLowerCase();
  30. }
  31. }
  32. //==============================================================================
  33. Project::Project (const File& f)
  34. : FileBasedDocument (projectFileExtension,
  35. String ("*") + projectFileExtension,
  36. "Choose a Jucer project to load",
  37. "Save Jucer project"),
  38. projectRoot (Ids::JUCERPROJECT),
  39. isSaving (false)
  40. {
  41. Logger::writeToLog ("Loading project: " + f.getFullPathName());
  42. setFile (f);
  43. removeDefunctExporters();
  44. updateOldModulePaths();
  45. setMissingDefaultValues();
  46. setChangedFlag (false);
  47. projectRoot.addListener (this);
  48. modificationTime = getFile().getLastModificationTime();
  49. }
  50. Project::~Project()
  51. {
  52. projectRoot.removeListener (this);
  53. ProjucerApplication::getApp().openDocumentManager.closeAllDocumentsUsingProject (*this, false);
  54. }
  55. const char* Project::projectFileExtension = ".jucer";
  56. //==============================================================================
  57. void Project::setTitle (const String& newTitle)
  58. {
  59. projectRoot.setProperty (Ids::name, newTitle, getUndoManagerFor (projectRoot));
  60. getMainGroup().getNameValue() = newTitle;
  61. }
  62. String Project::getDocumentTitle()
  63. {
  64. return getTitle();
  65. }
  66. void Project::updateProjectSettings()
  67. {
  68. projectRoot.setProperty (Ids::jucerVersion, ProjectInfo::versionString, nullptr);
  69. projectRoot.setProperty (Ids::name, getDocumentTitle(), nullptr);
  70. }
  71. void Project::setMissingDefaultValues()
  72. {
  73. if (! projectRoot.hasProperty (Ids::ID))
  74. projectRoot.setProperty (Ids::ID, createAlphaNumericUID(), nullptr);
  75. // Create main file group if missing
  76. if (! projectRoot.getChildWithName (Ids::MAINGROUP).isValid())
  77. {
  78. Item mainGroup (*this, ValueTree (Ids::MAINGROUP), false);
  79. projectRoot.addChild (mainGroup.state, 0, 0);
  80. }
  81. getMainGroup().initialiseMissingProperties();
  82. if (getDocumentTitle().isEmpty())
  83. setTitle ("JUCE Project");
  84. {
  85. auto defaultSplashScreen = ! ProjucerApplication::getApp().isPaidOrGPL();
  86. if (shouldDisplaySplashScreen() == var() || defaultSplashScreen)
  87. shouldDisplaySplashScreen() = defaultSplashScreen;
  88. if (ProjucerApplication::getApp().isPaidOrGPL())
  89. {
  90. if (shouldReportAppUsage() == var())
  91. shouldReportAppUsage() = ProjucerApplication::getApp().licenseController->getState().applicationUsageDataState
  92. == LicenseState::ApplicationUsageData::enabled;
  93. }
  94. else
  95. shouldReportAppUsage() = true;
  96. }
  97. if (splashScreenColour() == var())
  98. splashScreenColour() = "Dark";
  99. if (! projectRoot.hasProperty (Ids::projectType))
  100. getProjectTypeValue() = ProjectType_GUIApp::getTypeName();
  101. if (! projectRoot.hasProperty (Ids::version))
  102. getVersionValue() = "1.0.0";
  103. updateOldStyleConfigList();
  104. moveOldPropertyFromProjectToAllExporters (Ids::bigIcon);
  105. moveOldPropertyFromProjectToAllExporters (Ids::smallIcon);
  106. if (getProjectType().isAudioPlugin())
  107. setMissingAudioPluginDefaultValues();
  108. getModules().sortAlphabetically();
  109. if (getBundleIdentifier().toString().isEmpty())
  110. getBundleIdentifier() = getDefaultBundleIdentifier();
  111. if (shouldIncludeBinaryInAppConfig() == var())
  112. shouldIncludeBinaryInAppConfig() = true;
  113. if (! projectRoot.hasProperty (Ids::cppLanguageStandard) && ! setCppVersionFromOldExporterSettings())
  114. getCppStandardValue() = "14";
  115. if (getCompanyCopyright().toString().isEmpty())
  116. getCompanyCopyright() = getCompanyName().toString();
  117. ProjucerApplication::getApp().updateNewlyOpenedProject (*this);
  118. }
  119. bool Project::setCppVersionFromOldExporterSettings()
  120. {
  121. auto highestLanguageStandard = -1;
  122. for (Project::ExporterIterator exporter (*this); exporter.next();)
  123. {
  124. if (exporter->isXcode()) // cpp version was per-build configuration for xcode exporters
  125. {
  126. for (ProjectExporter::ConfigIterator config (*exporter); config.next();)
  127. {
  128. auto cppLanguageStandard = config->getValue (Ids::cppLanguageStandard).getValue();
  129. if (cppLanguageStandard != var())
  130. {
  131. auto versionNum = cppLanguageStandard.toString().getLastCharacters (2).getIntValue();
  132. if (versionNum > highestLanguageStandard)
  133. highestLanguageStandard = versionNum;
  134. }
  135. }
  136. }
  137. else
  138. {
  139. auto cppLanguageStandard = exporter->getSetting (Ids::cppLanguageStandard).getValue();
  140. if (cppLanguageStandard != var())
  141. {
  142. if (cppLanguageStandard.toString().containsIgnoreCase ("latest"))
  143. {
  144. getCppStandardValue() = "latest";
  145. return true;
  146. }
  147. auto versionNum = cppLanguageStandard.toString().getLastCharacters (2).getIntValue();
  148. if (versionNum > highestLanguageStandard)
  149. highestLanguageStandard = versionNum;
  150. }
  151. }
  152. }
  153. if (highestLanguageStandard != -1 && highestLanguageStandard >= 11)
  154. {
  155. getCppStandardValue() = highestLanguageStandard;
  156. return true;
  157. }
  158. return false;
  159. }
  160. void Project::updateDeprecatedProjectSettingsInteractively()
  161. {
  162. jassert (! ProjucerApplication::getApp().isRunningCommandLine);
  163. for (Project::ExporterIterator exporter (*this); exporter.next();)
  164. exporter->updateDeprecatedProjectSettingsInteractively();
  165. }
  166. void Project::setMissingAudioPluginDefaultValues()
  167. {
  168. const String sanitisedProjectName (CodeHelpers::makeValidIdentifier (getTitle(), false, true, false));
  169. setValueIfVoid (getShouldBuildVSTAsValue(), true);
  170. setValueIfVoid (getShouldBuildVST3AsValue(), false);
  171. setValueIfVoid (getShouldBuildAUAsValue(), true);
  172. setValueIfVoid (getShouldBuildAUv3AsValue(), false);
  173. setValueIfVoid (getShouldBuildRTASAsValue(), false);
  174. setValueIfVoid (getShouldBuildAAXAsValue(), false);
  175. setValueIfVoid (getShouldBuildStandalonePluginAsValue(), false);
  176. setValueIfVoid (getShouldEnableIAAAsValue(), false);
  177. setValueIfVoid (getPluginName(), getTitle());
  178. setValueIfVoid (getPluginDesc(), getTitle());
  179. setValueIfVoid (getPluginManufacturer(), "yourcompany");
  180. setValueIfVoid (getPluginManufacturerCode(), "Manu");
  181. setValueIfVoid (getPluginCode(), makeValid4CC (getProjectUID() + getProjectUID()));
  182. setValueIfVoid (getPluginChannelConfigs(), String());
  183. setValueIfVoid (getPluginIsSynth(), false);
  184. setValueIfVoid (getPluginWantsMidiInput(), false);
  185. setValueIfVoid (getPluginProducesMidiOut(), false);
  186. setValueIfVoid (getPluginIsMidiEffectPlugin(), false);
  187. setValueIfVoid (getPluginEditorNeedsKeyFocus(), false);
  188. setValueIfVoid (getPluginAUExportPrefix(), sanitisedProjectName + "AU");
  189. setValueIfVoid (getPluginRTASCategory(), String());
  190. setValueIfVoid (getBundleIdentifier(), getDefaultBundleIdentifier());
  191. setValueIfVoid (getAAXIdentifier(), getDefaultAAXIdentifier());
  192. setValueIfVoid (getPluginAAXCategory(), "AAX_ePlugInCategory_Dynamics");
  193. }
  194. void Project::updateOldStyleConfigList()
  195. {
  196. ValueTree deprecatedConfigsList (projectRoot.getChildWithName (Ids::CONFIGURATIONS));
  197. if (deprecatedConfigsList.isValid())
  198. {
  199. projectRoot.removeChild (deprecatedConfigsList, nullptr);
  200. for (Project::ExporterIterator exporter (*this); exporter.next();)
  201. {
  202. if (exporter->getNumConfigurations() == 0)
  203. {
  204. ValueTree newConfigs (deprecatedConfigsList.createCopy());
  205. if (! exporter->isXcode())
  206. {
  207. for (int j = newConfigs.getNumChildren(); --j >= 0;)
  208. {
  209. ValueTree config (newConfigs.getChild(j));
  210. config.removeProperty (Ids::osxSDK, nullptr);
  211. config.removeProperty (Ids::osxCompatibility, nullptr);
  212. config.removeProperty (Ids::osxArchitecture, nullptr);
  213. }
  214. }
  215. exporter->settings.addChild (newConfigs, 0, nullptr);
  216. }
  217. }
  218. }
  219. }
  220. void Project::moveOldPropertyFromProjectToAllExporters (Identifier name)
  221. {
  222. if (projectRoot.hasProperty (name))
  223. {
  224. for (Project::ExporterIterator exporter (*this); exporter.next();)
  225. exporter->settings.setProperty (name, projectRoot [name], nullptr);
  226. projectRoot.removeProperty (name, nullptr);
  227. }
  228. }
  229. void Project::removeDefunctExporters()
  230. {
  231. ValueTree exporters (projectRoot.getChildWithName (Ids::EXPORTFORMATS));
  232. StringPairArray oldExporters;
  233. oldExporters.set ("ANDROID", "Android Ant Exporter");
  234. oldExporters.set ("MSVC6", "MSVC6");
  235. oldExporters.set ("VS2010", "Visual Studio 2010");
  236. oldExporters.set ("VS2012", "Visual Studio 2012");
  237. for (auto& key : oldExporters.getAllKeys())
  238. {
  239. ValueTree oldExporter (exporters.getChildWithName (key));
  240. if (oldExporter.isValid())
  241. {
  242. AlertWindow::showMessageBox (AlertWindow::WarningIcon,
  243. TRANS (oldExporters[key]),
  244. TRANS ("The " + oldExporters[key] + " Exporter is deprecated. The exporter will be removed from this project."));
  245. exporters.removeChild (oldExporter, nullptr);
  246. }
  247. }
  248. }
  249. void Project::updateOldModulePaths()
  250. {
  251. for (Project::ExporterIterator exporter (*this); exporter.next();)
  252. exporter->updateOldModulePaths();
  253. }
  254. //==============================================================================
  255. static int getVersionElement (StringRef v, int index)
  256. {
  257. StringArray parts;
  258. parts.addTokens (v, "., ", StringRef());
  259. return parts [parts.size() - index - 1].getIntValue();
  260. }
  261. static int getJuceVersion (const String& v)
  262. {
  263. return getVersionElement (v, 2) * 100000
  264. + getVersionElement (v, 1) * 1000
  265. + getVersionElement (v, 0);
  266. }
  267. static int getBuiltJuceVersion()
  268. {
  269. return JUCE_MAJOR_VERSION * 100000
  270. + JUCE_MINOR_VERSION * 1000
  271. + JUCE_BUILDNUMBER;
  272. }
  273. static bool isAnyModuleNewerThanProjucer (const OwnedArray<ModuleDescription>& modules)
  274. {
  275. for (int i = modules.size(); --i >= 0;)
  276. {
  277. const ModuleDescription* m = modules.getUnchecked(i);
  278. if (m->getID().startsWith ("juce_")
  279. && getJuceVersion (m->getVersion()) > getBuiltJuceVersion())
  280. return true;
  281. }
  282. return false;
  283. }
  284. void Project::warnAboutOldProjucerVersion()
  285. {
  286. ModuleList available;
  287. available.scanGlobalJuceModulePath();
  288. if (! isAnyModuleNewerThanProjucer (available.modules))
  289. available.scanGlobalUserModulePath();
  290. if (! isAnyModuleNewerThanProjucer (available.modules))
  291. available.scanProjectExporterModulePaths (*this);
  292. if (! isAnyModuleNewerThanProjucer (available.modules))
  293. return;
  294. // Projucer is out of date!
  295. if (ProjucerApplication::getApp().isRunningCommandLine)
  296. std::cout << "WARNING! This version of the Projucer is out-of-date!" << std::endl;
  297. else
  298. AlertWindow::showMessageBoxAsync (AlertWindow::WarningIcon,
  299. "Projucer",
  300. "This version of the Projucer is out-of-date!"
  301. "\n\n"
  302. "Always make sure that you're running the very latest version, "
  303. "preferably compiled directly from the JUCE repository that you're working with!");
  304. }
  305. //==============================================================================
  306. static File lastDocumentOpened;
  307. File Project::getLastDocumentOpened() { return lastDocumentOpened; }
  308. void Project::setLastDocumentOpened (const File& file) { lastDocumentOpened = file; }
  309. static void registerRecentFile (const File& file)
  310. {
  311. RecentlyOpenedFilesList::registerRecentFileNatively (file);
  312. getAppSettings().recentFiles.addFile (file);
  313. getAppSettings().flush();
  314. }
  315. //==============================================================================
  316. Result Project::loadDocument (const File& file)
  317. {
  318. ScopedPointer<XmlElement> xml (XmlDocument::parse (file));
  319. if (xml == nullptr || ! xml->hasTagName (Ids::JUCERPROJECT.toString()))
  320. return Result::fail ("Not a valid Jucer project!");
  321. ValueTree newTree (ValueTree::fromXml (*xml));
  322. if (! newTree.hasType (Ids::JUCERPROJECT))
  323. return Result::fail ("The document contains errors and couldn't be parsed!");
  324. registerRecentFile (file);
  325. enabledModulesList.reset();
  326. projectRoot = newTree;
  327. removeDefunctExporters();
  328. setMissingDefaultValues();
  329. updateOldModulePaths();
  330. setChangedFlag (false);
  331. if (! ProjucerApplication::getApp().isRunningCommandLine)
  332. warnAboutOldProjucerVersion();
  333. return Result::ok();
  334. }
  335. Result Project::saveDocument (const File& file)
  336. {
  337. return saveProject (file, false);
  338. }
  339. Result Project::saveProject (const File& file, bool isCommandLineApp)
  340. {
  341. if (isSaving)
  342. return Result::ok();
  343. updateProjectSettings();
  344. sanitiseConfigFlags();
  345. if (! isCommandLineApp)
  346. registerRecentFile (file);
  347. const ScopedValueSetter<bool> vs (isSaving, true, false);
  348. ProjectSaver saver (*this, file);
  349. return saver.save (! isCommandLineApp, shouldWaitAfterSaving, specifiedExporterToSave);
  350. }
  351. Result Project::saveResourcesOnly (const File& file)
  352. {
  353. ProjectSaver saver (*this, file);
  354. return saver.saveResourcesOnly();
  355. }
  356. //==============================================================================
  357. void Project::valueTreePropertyChanged (ValueTree&, const Identifier& property)
  358. {
  359. if (property == Ids::projectType)
  360. setMissingDefaultValues();
  361. else if (property == Ids::name)
  362. setTitle (projectRoot [Ids::name]);
  363. changed();
  364. }
  365. void Project::valueTreeChildAdded (ValueTree&, ValueTree&) { changed(); }
  366. void Project::valueTreeChildRemoved (ValueTree&, ValueTree&, int) { changed(); }
  367. void Project::valueTreeChildOrderChanged (ValueTree&, int, int) { changed(); }
  368. void Project::valueTreeParentChanged (ValueTree&) {}
  369. //==============================================================================
  370. bool Project::hasProjectBeenModified()
  371. {
  372. Time oldModificationTime = modificationTime;
  373. modificationTime = getFile().getLastModificationTime();
  374. return (modificationTime.toMilliseconds() > (oldModificationTime.toMilliseconds() + 1000LL));
  375. }
  376. //==============================================================================
  377. File Project::resolveFilename (String filename) const
  378. {
  379. if (filename.isEmpty())
  380. return {};
  381. filename = replacePreprocessorDefs (getPreprocessorDefs(), filename);
  382. #if ! JUCE_WINDOWS
  383. if (filename.startsWith ("~"))
  384. return File::getSpecialLocation (File::userHomeDirectory).getChildFile (filename.trimCharactersAtStart ("~/"));
  385. #endif
  386. if (FileHelpers::isAbsolutePath (filename))
  387. return File::createFileWithoutCheckingPath (FileHelpers::currentOSStylePath (filename)); // (avoid assertions for windows-style paths)
  388. return getFile().getSiblingFile (FileHelpers::currentOSStylePath (filename));
  389. }
  390. String Project::getRelativePathForFile (const File& file) const
  391. {
  392. String filename (file.getFullPathName());
  393. File relativePathBase (getFile().getParentDirectory());
  394. String p1 (relativePathBase.getFullPathName());
  395. String p2 (file.getFullPathName());
  396. while (p1.startsWithChar (File::getSeparatorChar()))
  397. p1 = p1.substring (1);
  398. while (p2.startsWithChar (File::getSeparatorChar()))
  399. p2 = p2.substring (1);
  400. if (p1.upToFirstOccurrenceOf (File::getSeparatorString(), true, false)
  401. .equalsIgnoreCase (p2.upToFirstOccurrenceOf (File::getSeparatorString(), true, false)))
  402. {
  403. filename = FileHelpers::getRelativePathFrom (file, relativePathBase);
  404. }
  405. return filename;
  406. }
  407. //==============================================================================
  408. const ProjectType& Project::getProjectType() const
  409. {
  410. if (const ProjectType* type = ProjectType::findType (getProjectTypeString()))
  411. return *type;
  412. const ProjectType* guiType = ProjectType::findType (ProjectType_GUIApp::getTypeName());
  413. jassert (guiType != nullptr);
  414. return *guiType;
  415. }
  416. bool Project::shouldBuildTargetType (ProjectType::Target::Type targetType) const noexcept
  417. {
  418. const ProjectType& projectType = getProjectType();
  419. if (! projectType.supportsTargetType (targetType))
  420. return false;
  421. switch (targetType)
  422. {
  423. case ProjectType::Target::VSTPlugIn:
  424. return shouldBuildVST();
  425. case ProjectType::Target::VST3PlugIn:
  426. return shouldBuildVST3();
  427. case ProjectType::Target::AAXPlugIn:
  428. return shouldBuildAAX();
  429. case ProjectType::Target::RTASPlugIn:
  430. return shouldBuildRTAS();
  431. case ProjectType::Target::AudioUnitPlugIn:
  432. return shouldBuildAU();
  433. case ProjectType::Target::AudioUnitv3PlugIn:
  434. return shouldBuildAUv3();
  435. case ProjectType::Target::StandalonePlugIn:
  436. return shouldBuildStandalonePlugin();
  437. case ProjectType::Target::AggregateTarget:
  438. case ProjectType::Target::SharedCodeTarget:
  439. return projectType.isAudioPlugin();
  440. case ProjectType::Target::unspecified:
  441. return false;
  442. default:
  443. break;
  444. }
  445. return true;
  446. }
  447. ProjectType::Target::Type Project::getTargetTypeFromFilePath (const File& file, bool returnSharedTargetIfNoValidSuffix)
  448. {
  449. if (LibraryModule::CompileUnit::hasSuffix (file, "_AU")) return ProjectType::Target::AudioUnitPlugIn;
  450. else if (LibraryModule::CompileUnit::hasSuffix (file, "_AUv3")) return ProjectType::Target::AudioUnitv3PlugIn;
  451. else if (LibraryModule::CompileUnit::hasSuffix (file, "_AAX")) return ProjectType::Target::AAXPlugIn;
  452. else if (LibraryModule::CompileUnit::hasSuffix (file, "_RTAS")) return ProjectType::Target::RTASPlugIn;
  453. else if (LibraryModule::CompileUnit::hasSuffix (file, "_VST2")) return ProjectType::Target::VSTPlugIn;
  454. else if (LibraryModule::CompileUnit::hasSuffix (file, "_VST3")) return ProjectType::Target::VST3PlugIn;
  455. else if (LibraryModule::CompileUnit::hasSuffix (file, "_Standalone")) return ProjectType::Target::StandalonePlugIn;
  456. return (returnSharedTargetIfNoValidSuffix ? ProjectType::Target::SharedCodeTarget : ProjectType::Target::unspecified);
  457. }
  458. const char* ProjectType::Target::getName() const noexcept
  459. {
  460. switch (type)
  461. {
  462. case GUIApp: return "App";
  463. case ConsoleApp: return "ConsoleApp";
  464. case StaticLibrary: return "Static Library";
  465. case DynamicLibrary: return "Dynamic Library";
  466. case VSTPlugIn: return "VST";
  467. case VST3PlugIn: return "VST3";
  468. case AudioUnitPlugIn: return "AU";
  469. case StandalonePlugIn: return "Standalone Plugin";
  470. case AudioUnitv3PlugIn: return "AUv3 AppExtension";
  471. case AAXPlugIn: return "AAX";
  472. case RTASPlugIn: return "RTAS";
  473. case SharedCodeTarget: return "Shared Code";
  474. case AggregateTarget: return "All";
  475. default: return "undefined";
  476. }
  477. }
  478. ProjectType::Target::TargetFileType ProjectType::Target::getTargetFileType() const noexcept
  479. {
  480. switch (type)
  481. {
  482. case GUIApp: return executable;
  483. case ConsoleApp: return executable;
  484. case StaticLibrary: return staticLibrary;
  485. case DynamicLibrary: return sharedLibraryOrDLL;
  486. case VSTPlugIn: return pluginBundle;
  487. case VST3PlugIn: return pluginBundle;
  488. case AudioUnitPlugIn: return pluginBundle;
  489. case StandalonePlugIn: return executable;
  490. case AudioUnitv3PlugIn: return macOSAppex;
  491. case AAXPlugIn: return pluginBundle;
  492. case RTASPlugIn: return pluginBundle;
  493. case SharedCodeTarget: return staticLibrary;
  494. default:
  495. break;
  496. }
  497. return unknown;
  498. }
  499. //==============================================================================
  500. void Project::createPropertyEditors (PropertyListBuilder& props)
  501. {
  502. props.add (new TextPropertyComponent (getProjectNameValue(), "Project Name", 256, false),
  503. "The name of the project.");
  504. props.add (new TextPropertyComponent (getVersionValue(), "Project Version", 16, false),
  505. "The project's version number, This should be in the format major.minor.point[.point]");
  506. props.add (new TextPropertyComponent (getCompanyName(), "Company Name", 256, false),
  507. "Your company name, which will be added to the properties of the binary where possible");
  508. props.add (new TextPropertyComponent (getCompanyCopyright(), "Company Copyright", 256, false),
  509. "Your company copyright, which will be added to the properties of the binary where possible");
  510. props.add (new TextPropertyComponent (getCompanyWebsite(), "Company Website", 256, false),
  511. "Your company website, which will be added to the properties of the binary where possible");
  512. props.add (new TextPropertyComponent (getCompanyEmail(), "Company E-mail", 256, false),
  513. "Your company e-mail, which will be added to the properties of the binary where possible");
  514. {
  515. const String licenseRequiredTagline ("Required for closed source applications without an Indie or Pro JUCE license");
  516. const String licenseRequiredInfo ("In accordance with the terms of the JUCE 5 End-Use License Agreement (www.juce.com/juce-5-licence), "
  517. "this option can only be disabled for closed source applications if you have a JUCE Indie or Pro "
  518. "license, or are using JUCE under the GPL v3 license.");
  519. StringPairArray description;
  520. description.set ("Report JUCE app usage", "This option controls the collection of usage data from users of this JUCE application.");
  521. description.set ("Display the JUCE splash screen", "This option controls the display of the standard JUCE splash screen.");
  522. if (ProjucerApplication::getApp().isPaidOrGPL())
  523. {
  524. props.add (new BooleanPropertyComponent (shouldReportAppUsage(), "Report JUCE app usage", licenseRequiredTagline),
  525. description["Report JUCE app usage"] + " " + licenseRequiredInfo);
  526. props.add (new BooleanPropertyComponent (shouldDisplaySplashScreen(), "Display the JUCE splash screen", licenseRequiredTagline),
  527. description["Display the JUCE splash screen"] + " " + licenseRequiredInfo);
  528. }
  529. else
  530. {
  531. StringArray options;
  532. Array<var> vars;
  533. options.add (licenseRequiredTagline);
  534. vars.add (var());
  535. props.add (new ChoicePropertyComponent (Value(), "Report JUCE app usage", options, vars),
  536. description["Report JUCE app usage"] + " " + licenseRequiredInfo);
  537. props.add (new ChoicePropertyComponent (Value(), "Display the JUCE splash screen", options, vars),
  538. description["Display the JUCE splash screen"] + " " + licenseRequiredInfo);
  539. }
  540. }
  541. {
  542. StringArray splashScreenColours;
  543. splashScreenColours.add ("Dark");
  544. splashScreenColours.add ("Light");
  545. Array<var> splashScreenCodes;
  546. for (auto& splashScreenColour : splashScreenColours)
  547. splashScreenCodes.add (splashScreenColour);
  548. props.add (new ChoicePropertyComponent (splashScreenColour(), "Splash screen colour", splashScreenColours, splashScreenCodes),
  549. "Choose the colour of the JUCE splash screen.");
  550. }
  551. {
  552. StringArray projectTypeNames;
  553. Array<var> projectTypeCodes;
  554. const Array<ProjectType*>& types = ProjectType::getAllTypes();
  555. for (int i = 0; i < types.size(); ++i)
  556. {
  557. projectTypeNames.add (types.getUnchecked(i)->getDescription());
  558. projectTypeCodes.add (types.getUnchecked(i)->getType());
  559. }
  560. props.add (new ChoicePropertyComponent (getProjectTypeValue(), "Project Type", projectTypeNames, projectTypeCodes));
  561. }
  562. props.add (new TextPropertyComponent (getBundleIdentifier(), "Bundle Identifier", 256, false),
  563. "A unique identifier for this product, mainly for use in OSX/iOS builds. It should be something like 'com.yourcompanyname.yourproductname'");
  564. if (getProjectType().isAudioPlugin())
  565. createAudioPluginPropertyEditors (props);
  566. {
  567. const int maxSizes[] = { 20480, 10240, 6144, 2048, 1024, 512, 256, 128, 64 };
  568. StringArray maxSizeNames;
  569. Array<var> maxSizeCodes;
  570. maxSizeNames.add (TRANS("Default"));
  571. maxSizeCodes.add (var());
  572. maxSizeNames.add (String());
  573. maxSizeCodes.add (var());
  574. for (int i = 0; i < numElementsInArray (maxSizes); ++i)
  575. {
  576. const int sizeInBytes = maxSizes[i] * 1024;
  577. maxSizeNames.add (File::descriptionOfSizeInBytes (sizeInBytes));
  578. maxSizeCodes.add (sizeInBytes);
  579. }
  580. props.add (new ChoicePropertyComponent (getMaxBinaryFileSize(), "BinaryData.cpp size limit", maxSizeNames, maxSizeCodes),
  581. "When splitting binary data into multiple cpp files, the Projucer attempts to keep the file sizes below this threshold. "
  582. "(Note that individual resource files which are larger than this size cannot be split across multiple cpp files).");
  583. }
  584. props.add (new BooleanPropertyComponent (shouldIncludeBinaryInAppConfig(), "Include Binary",
  585. "Include BinaryData.h in the AppConfig.h file"));
  586. props.add (new TextPropertyComponent (binaryDataNamespace(), "BinaryData Namespace", 256, false),
  587. "The namespace containing the binary assests. If left empty this defaults to \"BinaryData\".");
  588. {
  589. static const char* cppLanguageStandardNames[] = { "C++11", "C++14", "Use Latest", nullptr };
  590. static const var cppLanguageStandardValues[] = { "11", "14", "latest" };
  591. props.add (new ChoicePropertyComponent (getCppStandardValue(), "C++ Language Standard",
  592. StringArray (cppLanguageStandardNames),
  593. Array<var> (cppLanguageStandardValues, numElementsInArray (cppLanguageStandardValues))),
  594. "The standard of the C++ language that will be used for compilation.");
  595. }
  596. props.add (new TextPropertyComponent (getProjectPreprocessorDefs(), "Preprocessor definitions", 32768, true),
  597. "Global preprocessor definitions. Use the form \"NAME1=value NAME2=value\", using whitespace, commas, or "
  598. "new-lines to separate the items - to include a space or comma in a definition, precede it with a backslash.");
  599. props.addSearchPathProperty (getProjectHeaderSearchPaths(), "Header search paths", "Global header search paths.");
  600. props.add (new TextPropertyComponent (getProjectUserNotes(), "Notes", 32768, true),
  601. "Extra comments: This field is not used for code or project generation, it's just a space where you can express your thoughts.");
  602. }
  603. void Project::createAudioPluginPropertyEditors (PropertyListBuilder& props)
  604. {
  605. props.add (new BooleanPropertyComponent (getShouldBuildVSTAsValue(), "Build VST", "Enabled"),
  606. "Whether the project should produce a VST plugin.");
  607. props.add (new BooleanPropertyComponent (getShouldBuildVST3AsValue(), "Build VST3", "Enabled"),
  608. "Whether the project should produce a VST3 plugin.");
  609. props.add (new BooleanPropertyComponent (getShouldBuildAUAsValue(), "Build AudioUnit", "Enabled"),
  610. "Whether the project should produce an AudioUnit plugin.");
  611. props.add (new BooleanPropertyComponent (getShouldBuildAUv3AsValue(), "Build AudioUnit v3", "Enabled"),
  612. "Whether the project should produce an AudioUnit version 3 plugin.");
  613. props.add (new BooleanPropertyComponent (getShouldBuildRTASAsValue(), "Build RTAS", "Enabled"),
  614. "Whether the project should produce an RTAS plugin.");
  615. props.add (new BooleanPropertyComponent (getShouldBuildAAXAsValue(), "Build AAX", "Enabled"),
  616. "Whether the project should produce an AAX plugin.");
  617. props.add (new BooleanPropertyComponent (getShouldBuildStandalonePluginAsValue(), "Build Standalone Plug-In", "Enabled"),
  618. "Whether the project should produce a standalone version of your plugin.");
  619. props.add (new BooleanPropertyComponent (getShouldEnableIAAAsValue(), "Enable Inter-App Audio", "Enabled"),
  620. "Whether a standalone plug-in should be an Inter-App Audio app. You should also enable the audio "
  621. "background capability in the iOS exporter.");
  622. props.add (new TextPropertyComponent (getPluginName(), "Plugin Name", 128, false),
  623. "The name of your plugin (keep it short!)");
  624. props.add (new TextPropertyComponent (getPluginDesc(), "Plugin Description", 256, false),
  625. "A short description of your plugin.");
  626. props.add (new TextPropertyComponent (getPluginManufacturer(), "Plugin Manufacturer", 256, false),
  627. "The name of your company (cannot be blank).");
  628. props.add (new TextPropertyComponent (getPluginManufacturerCode(), "Plugin Manufacturer Code", 4, false),
  629. "A four-character unique ID for your company. Note that for AU compatibility, this must contain at least one upper-case letter!");
  630. props.add (new TextPropertyComponent (getPluginCode(), "Plugin Code", 4, false),
  631. "A four-character unique ID for your plugin. Note that for AU compatibility, this must contain at least one upper-case letter!");
  632. props.add (new TextPropertyComponent (getPluginChannelConfigs(), "Plugin Channel Configurations", 1024, false),
  633. "This list is a comma-separated set list in the form {numIns, numOuts} and each pair indicates a valid plug-in "
  634. "configuration. For example {1, 1}, {2, 2} means that the plugin can be used either with 1 input and 1 output, "
  635. "or with 2 inputs and 2 outputs. If your plug-in requires side-chains, aux output buses etc., then you must leave "
  636. "this field empty and override the isBusesLayoutSupported callback in your AudioProcessor.");
  637. props.add (new BooleanPropertyComponent (getPluginIsSynth(), "Plugin is a Synth", "Is a Synth"),
  638. "Enable this if you want your plugin to be treated as a synth or generator. It doesn't make much difference to the plugin itself, but some hosts treat synths differently to other plugins.");
  639. props.add (new BooleanPropertyComponent (getPluginWantsMidiInput(), "Plugin Midi Input", "Plugin wants midi input"),
  640. "Enable this if you want your plugin to accept midi messages.");
  641. props.add (new BooleanPropertyComponent (getPluginProducesMidiOut(), "Plugin Midi Output", "Plugin produces midi output"),
  642. "Enable this if your plugin is going to produce midi messages.");
  643. props.add (new BooleanPropertyComponent (getPluginIsMidiEffectPlugin(), "Midi Effect Plugin", "Plugin is a midi effect plugin"),
  644. "Enable this if your plugin only processes midi and no audio.");
  645. props.add (new BooleanPropertyComponent (getPluginEditorNeedsKeyFocus(), "Key Focus", "Plugin editor requires keyboard focus"),
  646. "Enable this if your plugin needs keyboard input - some hosts can be a bit funny about keyboard focus..");
  647. props.add (new TextPropertyComponent (getPluginAUExportPrefix(), "Plugin AU Export Prefix", 64, false),
  648. "A prefix for the names of exported entry-point functions that the component exposes - typically this will be a version of your plugin's name that can be used as part of a C++ token.");
  649. props.add (new TextPropertyComponent (getPluginAUMainType(), "Plugin AU Main Type", 128, false),
  650. "In an AU, this is the value that is set as JucePlugin_AUMainType. Leave it blank unless you want to use a custom value.");
  651. props.add (new TextPropertyComponent (getPluginVSTCategory(), "VST Category", 64, false),
  652. "In a VST, this is the value that is set as JucePlugin_VSTCategory. Leave it blank unless you want to use a custom value.");
  653. props.add (new TextPropertyComponent (getPluginRTASCategory(), "Plugin RTAS Category", 64, false),
  654. "(Leave this blank if your plugin is a synth). This is one of the RTAS categories from FicPluginEnums.h, such as: ePlugInCategory_None, ePlugInCategory_EQ, ePlugInCategory_Dynamics, "
  655. "ePlugInCategory_PitchShift, ePlugInCategory_Reverb, ePlugInCategory_Delay, "
  656. "ePlugInCategory_Modulation, ePlugInCategory_Harmonic, ePlugInCategory_NoiseReduction, "
  657. "ePlugInCategory_Dither, ePlugInCategory_SoundField");
  658. props.add (new TextPropertyComponent (getPluginAAXCategory(), "Plugin AAX Category", 64, false),
  659. "This is one of the categories from the AAX_EPlugInCategory enum");
  660. props.add (new TextPropertyComponent (getAAXIdentifier(), "Plugin AAX Identifier", 256, false),
  661. "The value to use for the JucePlugin_AAXIdentifier setting");
  662. }
  663. //==============================================================================
  664. static StringArray getVersionSegments (const Project& p)
  665. {
  666. StringArray segments;
  667. segments.addTokens (p.getVersionString(), ",.", "");
  668. segments.trim();
  669. segments.removeEmptyStrings();
  670. return segments;
  671. }
  672. int Project::getVersionAsHexInteger() const
  673. {
  674. const StringArray segments (getVersionSegments (*this));
  675. int value = (segments[0].getIntValue() << 16)
  676. + (segments[1].getIntValue() << 8)
  677. + segments[2].getIntValue();
  678. if (segments.size() >= 4)
  679. value = (value << 8) + segments[3].getIntValue();
  680. return value;
  681. }
  682. String Project::getVersionAsHex() const
  683. {
  684. return "0x" + String::toHexString (getVersionAsHexInteger());
  685. }
  686. StringPairArray Project::getPreprocessorDefs() const
  687. {
  688. return parsePreprocessorDefs (projectRoot [Ids::defines]);
  689. }
  690. File Project::getBinaryDataCppFile (int index) const
  691. {
  692. const File cpp (getGeneratedCodeFolder().getChildFile ("BinaryData.cpp"));
  693. if (index > 0)
  694. return cpp.getSiblingFile (cpp.getFileNameWithoutExtension() + String (index + 1))
  695. .withFileExtension (cpp.getFileExtension());
  696. return cpp;
  697. }
  698. Project::Item Project::getMainGroup()
  699. {
  700. return Item (*this, projectRoot.getChildWithName (Ids::MAINGROUP), false);
  701. }
  702. PropertiesFile& Project::getStoredProperties() const
  703. {
  704. return getAppSettings().getProjectProperties (getProjectUID());
  705. }
  706. static void findImages (const Project::Item& item, OwnedArray<Project::Item>& found)
  707. {
  708. if (item.isImageFile())
  709. {
  710. found.add (new Project::Item (item));
  711. }
  712. else if (item.isGroup())
  713. {
  714. for (int i = 0; i < item.getNumChildren(); ++i)
  715. findImages (item.getChild (i), found);
  716. }
  717. }
  718. void Project::findAllImageItems (OwnedArray<Project::Item>& items)
  719. {
  720. findImages (getMainGroup(), items);
  721. }
  722. //==============================================================================
  723. Project::Item::Item (Project& p, const ValueTree& s, bool isModuleCode)
  724. : project (p), state (s), belongsToModule (isModuleCode)
  725. {
  726. }
  727. Project::Item::Item (const Item& other)
  728. : project (other.project), state (other.state), belongsToModule (other.belongsToModule)
  729. {
  730. }
  731. Project::Item Project::Item::createCopy() { Item i (*this); i.state = i.state.createCopy(); return i; }
  732. String Project::Item::getID() const { return state [Ids::ID]; }
  733. void Project::Item::setID (const String& newID) { state.setProperty (Ids::ID, newID, nullptr); }
  734. Drawable* Project::Item::loadAsImageFile() const
  735. {
  736. const MessageManagerLock mml (ThreadPoolJob::getCurrentThreadPoolJob());
  737. return isValid() ? Drawable::createFromImageFile (getFile())
  738. : nullptr;
  739. }
  740. Project::Item Project::Item::createGroup (Project& project, const String& name, const String& uid, bool isModuleCode)
  741. {
  742. Item group (project, ValueTree (Ids::GROUP), isModuleCode);
  743. group.setID (uid);
  744. group.initialiseMissingProperties();
  745. group.getNameValue() = name;
  746. return group;
  747. }
  748. bool Project::Item::isFile() const { return state.hasType (Ids::FILE); }
  749. bool Project::Item::isGroup() const { return state.hasType (Ids::GROUP) || isMainGroup(); }
  750. bool Project::Item::isMainGroup() const { return state.hasType (Ids::MAINGROUP); }
  751. bool Project::Item::isImageFile() const
  752. {
  753. return isFile() && (ImageFileFormat::findImageFormatForFileExtension (getFile()) != nullptr
  754. || getFile().hasFileExtension ("svg"));
  755. }
  756. Project::Item Project::Item::findItemWithID (const String& targetId) const
  757. {
  758. if (state [Ids::ID] == targetId)
  759. return *this;
  760. if (isGroup())
  761. {
  762. for (int i = getNumChildren(); --i >= 0;)
  763. {
  764. Item found (getChild(i).findItemWithID (targetId));
  765. if (found.isValid())
  766. return found;
  767. }
  768. }
  769. return Item (project, ValueTree(), false);
  770. }
  771. bool Project::Item::canContain (const Item& child) const
  772. {
  773. if (isFile())
  774. return false;
  775. if (isGroup())
  776. return child.isFile() || child.isGroup();
  777. jassertfalse;
  778. return false;
  779. }
  780. bool Project::Item::shouldBeAddedToTargetProject() const { return isFile(); }
  781. Value Project::Item::getShouldCompileValue() { return state.getPropertyAsValue (Ids::compile, getUndoManager()); }
  782. bool Project::Item::shouldBeCompiled() const { return state [Ids::compile]; }
  783. Value Project::Item::getShouldAddToBinaryResourcesValue() { return state.getPropertyAsValue (Ids::resource, getUndoManager()); }
  784. bool Project::Item::shouldBeAddedToBinaryResources() const { return state [Ids::resource]; }
  785. Value Project::Item::getShouldAddToXcodeResourcesValue() { return state.getPropertyAsValue (Ids::xcodeResource, getUndoManager()); }
  786. bool Project::Item::shouldBeAddedToXcodeResources() const { return state [Ids::xcodeResource]; }
  787. Value Project::Item::getShouldInhibitWarningsValue() { return state.getPropertyAsValue (Ids::noWarnings, getUndoManager()); }
  788. bool Project::Item::shouldInhibitWarnings() const { return state [Ids::noWarnings]; }
  789. bool Project::Item::isModuleCode() const { return belongsToModule; }
  790. String Project::Item::getFilePath() const
  791. {
  792. if (isFile())
  793. return state [Ids::file].toString();
  794. return {};
  795. }
  796. File Project::Item::getFile() const
  797. {
  798. if (isFile())
  799. return project.resolveFilename (state [Ids::file].toString());
  800. return {};
  801. }
  802. void Project::Item::setFile (const File& file)
  803. {
  804. setFile (RelativePath (project.getRelativePathForFile (file), RelativePath::projectFolder));
  805. jassert (getFile() == file);
  806. }
  807. void Project::Item::setFile (const RelativePath& file)
  808. {
  809. jassert (isFile());
  810. state.setProperty (Ids::file, file.toUnixStyle(), getUndoManager());
  811. state.setProperty (Ids::name, file.getFileName(), getUndoManager());
  812. }
  813. bool Project::Item::renameFile (const File& newFile)
  814. {
  815. const File oldFile (getFile());
  816. if (oldFile.moveFileTo (newFile)
  817. || (newFile.exists() && ! oldFile.exists()))
  818. {
  819. setFile (newFile);
  820. ProjucerApplication::getApp().openDocumentManager.fileHasBeenRenamed (oldFile, newFile);
  821. return true;
  822. }
  823. return false;
  824. }
  825. bool Project::Item::containsChildForFile (const RelativePath& file) const
  826. {
  827. return state.getChildWithProperty (Ids::file, file.toUnixStyle()).isValid();
  828. }
  829. Project::Item Project::Item::findItemForFile (const File& file) const
  830. {
  831. if (getFile() == file)
  832. return *this;
  833. if (isGroup())
  834. {
  835. for (int i = getNumChildren(); --i >= 0;)
  836. {
  837. Item found (getChild(i).findItemForFile (file));
  838. if (found.isValid())
  839. return found;
  840. }
  841. }
  842. return Item (project, ValueTree(), false);
  843. }
  844. File Project::Item::determineGroupFolder() const
  845. {
  846. jassert (isGroup());
  847. File f;
  848. for (int i = 0; i < getNumChildren(); ++i)
  849. {
  850. f = getChild(i).getFile();
  851. if (f.exists())
  852. return f.getParentDirectory();
  853. }
  854. Item parent (getParent());
  855. if (parent != *this)
  856. {
  857. f = parent.determineGroupFolder();
  858. if (f.getChildFile (getName()).isDirectory())
  859. f = f.getChildFile (getName());
  860. }
  861. else
  862. {
  863. f = project.getProjectFolder();
  864. if (f.getChildFile ("Source").isDirectory())
  865. f = f.getChildFile ("Source");
  866. }
  867. return f;
  868. }
  869. void Project::Item::initialiseMissingProperties()
  870. {
  871. if (! state.hasProperty (Ids::ID))
  872. setID (createAlphaNumericUID());
  873. if (isFile())
  874. {
  875. state.setProperty (Ids::name, getFile().getFileName(), nullptr);
  876. }
  877. else if (isGroup())
  878. {
  879. for (int i = getNumChildren(); --i >= 0;)
  880. getChild(i).initialiseMissingProperties();
  881. }
  882. }
  883. Value Project::Item::getNameValue()
  884. {
  885. return state.getPropertyAsValue (Ids::name, getUndoManager());
  886. }
  887. String Project::Item::getName() const
  888. {
  889. return state [Ids::name];
  890. }
  891. void Project::Item::addChild (const Item& newChild, int insertIndex)
  892. {
  893. state.addChild (newChild.state, insertIndex, getUndoManager());
  894. }
  895. void Project::Item::removeItemFromProject()
  896. {
  897. state.getParent().removeChild (state, getUndoManager());
  898. }
  899. Project::Item Project::Item::getParent() const
  900. {
  901. if (isMainGroup() || ! isGroup())
  902. return *this;
  903. return Item (project, state.getParent(), belongsToModule);
  904. }
  905. struct ItemSorter
  906. {
  907. static int compareElements (const ValueTree& first, const ValueTree& second)
  908. {
  909. return first [Ids::name].toString().compareNatural (second [Ids::name].toString());
  910. }
  911. };
  912. struct ItemSorterWithGroupsAtStart
  913. {
  914. static int compareElements (const ValueTree& first, const ValueTree& second)
  915. {
  916. const bool firstIsGroup = first.hasType (Ids::GROUP);
  917. const bool secondIsGroup = second.hasType (Ids::GROUP);
  918. if (firstIsGroup == secondIsGroup)
  919. return first [Ids::name].toString().compareNatural (second [Ids::name].toString());
  920. return firstIsGroup ? -1 : 1;
  921. }
  922. };
  923. static void sortGroup (ValueTree& state, bool keepGroupsAtStart, UndoManager* undoManager)
  924. {
  925. if (keepGroupsAtStart)
  926. {
  927. ItemSorterWithGroupsAtStart sorter;
  928. state.sort (sorter, undoManager, true);
  929. }
  930. else
  931. {
  932. ItemSorter sorter;
  933. state.sort (sorter, undoManager, true);
  934. }
  935. }
  936. static bool isGroupSorted (const ValueTree& state, bool keepGroupsAtStart)
  937. {
  938. if (state.getNumChildren() == 0)
  939. return false;
  940. if (state.getNumChildren() == 1)
  941. return true;
  942. ValueTree stateCopy (state.createCopy());
  943. sortGroup (stateCopy, keepGroupsAtStart, nullptr);
  944. return stateCopy.isEquivalentTo (state);
  945. }
  946. void Project::Item::sortAlphabetically (bool keepGroupsAtStart, bool recursive)
  947. {
  948. sortGroup (state, keepGroupsAtStart, getUndoManager());
  949. if (recursive)
  950. for (int i = getNumChildren(); --i >= 0;)
  951. getChild(i).sortAlphabetically (keepGroupsAtStart, true);
  952. }
  953. Project::Item Project::Item::getOrCreateSubGroup (const String& name)
  954. {
  955. for (int i = state.getNumChildren(); --i >= 0;)
  956. {
  957. const ValueTree child (state.getChild (i));
  958. if (child.getProperty (Ids::name) == name && child.hasType (Ids::GROUP))
  959. return Item (project, child, belongsToModule);
  960. }
  961. return addNewSubGroup (name, -1);
  962. }
  963. Project::Item Project::Item::addNewSubGroup (const String& name, int insertIndex)
  964. {
  965. String newID (createGUID (getID() + name + String (getNumChildren())));
  966. int n = 0;
  967. while (project.getMainGroup().findItemWithID (newID).isValid())
  968. newID = createGUID (newID + String (++n));
  969. Item group (createGroup (project, name, newID, belongsToModule));
  970. jassert (canContain (group));
  971. addChild (group, insertIndex);
  972. return group;
  973. }
  974. bool Project::Item::addFileAtIndex (const File& file, int insertIndex, const bool shouldCompile)
  975. {
  976. if (file == File() || file.isHidden() || file.getFileName().startsWithChar ('.'))
  977. return false;
  978. if (file.isDirectory())
  979. {
  980. Item group (addNewSubGroup (file.getFileName(), insertIndex));
  981. for (DirectoryIterator iter (file, false, "*", File::findFilesAndDirectories); iter.next();)
  982. if (! project.getMainGroup().findItemForFile (iter.getFile()).isValid())
  983. group.addFileRetainingSortOrder (iter.getFile(), shouldCompile);
  984. }
  985. else if (file.existsAsFile())
  986. {
  987. if (! project.getMainGroup().findItemForFile (file).isValid())
  988. addFileUnchecked (file, insertIndex, shouldCompile);
  989. }
  990. else
  991. {
  992. jassertfalse;
  993. }
  994. return true;
  995. }
  996. bool Project::Item::addFileRetainingSortOrder (const File& file, bool shouldCompile)
  997. {
  998. const bool wasSortedGroupsNotFirst = isGroupSorted (state, false);
  999. const bool wasSortedGroupsFirst = isGroupSorted (state, true);
  1000. if (! addFileAtIndex (file, 0, shouldCompile))
  1001. return false;
  1002. if (wasSortedGroupsNotFirst || wasSortedGroupsFirst)
  1003. sortAlphabetically (wasSortedGroupsFirst, false);
  1004. return true;
  1005. }
  1006. void Project::Item::addFileUnchecked (const File& file, int insertIndex, const bool shouldCompile)
  1007. {
  1008. Item item (project, ValueTree (Ids::FILE), belongsToModule);
  1009. item.initialiseMissingProperties();
  1010. item.getNameValue() = file.getFileName();
  1011. item.getShouldCompileValue() = shouldCompile && file.hasFileExtension (fileTypesToCompileByDefault);
  1012. item.getShouldAddToBinaryResourcesValue() = project.shouldBeAddedToBinaryResourcesByDefault (file);
  1013. if (canContain (item))
  1014. {
  1015. item.setFile (file);
  1016. addChild (item, insertIndex);
  1017. }
  1018. }
  1019. bool Project::Item::addRelativeFile (const RelativePath& file, int insertIndex, bool shouldCompile)
  1020. {
  1021. Item item (project, ValueTree (Ids::FILE), belongsToModule);
  1022. item.initialiseMissingProperties();
  1023. item.getNameValue() = file.getFileName();
  1024. item.getShouldCompileValue() = shouldCompile;
  1025. item.getShouldAddToBinaryResourcesValue() = project.shouldBeAddedToBinaryResourcesByDefault (file);
  1026. if (canContain (item))
  1027. {
  1028. item.setFile (file);
  1029. addChild (item, insertIndex);
  1030. return true;
  1031. }
  1032. return false;
  1033. }
  1034. Icon Project::Item::getIcon (bool isOpen) const
  1035. {
  1036. const Icons& icons = getIcons();
  1037. if (isFile())
  1038. {
  1039. if (isImageFile())
  1040. return Icon (icons.imageDoc, Colours::transparentBlack);
  1041. return Icon (icons.file, Colours::transparentBlack);
  1042. }
  1043. if (isMainGroup())
  1044. return Icon (icons.juceLogo, Colours::orange);
  1045. return Icon (isOpen ? icons.openFolder : icons.closedFolder, Colours::transparentBlack);
  1046. }
  1047. bool Project::Item::isIconCrossedOut() const
  1048. {
  1049. return isFile()
  1050. && ! (shouldBeCompiled()
  1051. || shouldBeAddedToBinaryResources()
  1052. || getFile().hasFileExtension (headerFileExtensions));
  1053. }
  1054. //==============================================================================
  1055. ValueTree Project::getConfigNode()
  1056. {
  1057. return projectRoot.getOrCreateChildWithName (Ids::JUCEOPTIONS, nullptr);
  1058. }
  1059. const char* const Project::configFlagDefault = "default";
  1060. const char* const Project::configFlagEnabled = "enabled";
  1061. const char* const Project::configFlagDisabled = "disabled";
  1062. Value Project::getConfigFlag (const String& name)
  1063. {
  1064. ValueTree configNode (getConfigNode());
  1065. Value v (configNode.getPropertyAsValue (name, getUndoManagerFor (configNode)));
  1066. if (v.getValue().toString().isEmpty())
  1067. v = configFlagDefault;
  1068. return v;
  1069. }
  1070. bool Project::isConfigFlagEnabled (const String& name, bool defaultIsEnabled) const
  1071. {
  1072. String configValue = projectRoot.getChildWithName (Ids::JUCEOPTIONS).getProperty (name);
  1073. if (configValue == configFlagDefault)
  1074. return defaultIsEnabled;
  1075. return (configValue == configFlagEnabled);
  1076. }
  1077. void Project::sanitiseConfigFlags()
  1078. {
  1079. ValueTree configNode (getConfigNode());
  1080. for (int i = configNode.getNumProperties(); --i >= 0;)
  1081. {
  1082. const var value (configNode [configNode.getPropertyName(i)]);
  1083. if (value != configFlagEnabled && value != configFlagDisabled)
  1084. configNode.removeProperty (configNode.getPropertyName(i), getUndoManagerFor (configNode));
  1085. }
  1086. }
  1087. //==============================================================================
  1088. String Project::getPluginRTASCategoryCode()
  1089. {
  1090. if (static_cast<bool> (getPluginIsSynth().getValue()))
  1091. return "ePlugInCategory_SWGenerators";
  1092. String s (getPluginRTASCategory().toString());
  1093. if (s.isEmpty())
  1094. s = "ePlugInCategory_None";
  1095. return s;
  1096. }
  1097. String Project::getAUMainTypeString()
  1098. {
  1099. String s (getPluginAUMainType().toString());
  1100. if (s.isEmpty())
  1101. {
  1102. // Unfortunately, Rez uses a header where kAudioUnitType_MIDIProcessor is undefined
  1103. // Use aumi instead.
  1104. if (getPluginIsMidiEffectPlugin().getValue()) s = "'aumi'";
  1105. else if (getPluginIsSynth().getValue()) s = "kAudioUnitType_MusicDevice";
  1106. else if (getPluginWantsMidiInput().getValue()) s = "kAudioUnitType_MusicEffect";
  1107. else s = "kAudioUnitType_Effect";
  1108. }
  1109. return s;
  1110. }
  1111. String Project::getAUMainTypeCode()
  1112. {
  1113. String s (getPluginAUMainType().toString());
  1114. if (s.isEmpty())
  1115. {
  1116. if (getPluginIsMidiEffectPlugin().getValue()) s = "aumi";
  1117. else if (getPluginIsSynth().getValue()) s = "aumu";
  1118. else if (getPluginWantsMidiInput().getValue()) s = "aumf";
  1119. else s = "aufx";
  1120. }
  1121. return s;
  1122. }
  1123. String Project::getIAATypeCode()
  1124. {
  1125. String s;
  1126. if (getPluginWantsMidiInput().getValue())
  1127. {
  1128. if (getPluginIsSynth().getValue())
  1129. s = "auri";
  1130. else
  1131. s = "aurm";
  1132. }
  1133. else
  1134. {
  1135. if (getPluginIsSynth().getValue())
  1136. s = "aurg";
  1137. else
  1138. s = "aurx";
  1139. }
  1140. return s;
  1141. }
  1142. String Project::getIAAPluginName()
  1143. {
  1144. String s = getPluginManufacturer().toString();
  1145. s << ": ";
  1146. s << getPluginName().toString();
  1147. return s;
  1148. }
  1149. String Project::getPluginVSTCategoryString()
  1150. {
  1151. String s (getPluginVSTCategory().toString().trim());
  1152. if (s.isEmpty())
  1153. s = static_cast<bool> (getPluginIsSynth().getValue()) ? "kPlugCategSynth"
  1154. : "kPlugCategEffect";
  1155. return s;
  1156. }
  1157. bool Project::isAUPluginHost()
  1158. {
  1159. return getModules().isModuleEnabled ("juce_audio_processors") && isConfigFlagEnabled ("JUCE_PLUGINHOST_AU");
  1160. }
  1161. bool Project::isVSTPluginHost()
  1162. {
  1163. return getModules().isModuleEnabled ("juce_audio_processors") && isConfigFlagEnabled ("JUCE_PLUGINHOST_VST");
  1164. }
  1165. bool Project::isVST3PluginHost()
  1166. {
  1167. return getModules().isModuleEnabled ("juce_audio_processors") && isConfigFlagEnabled ("JUCE_PLUGINHOST_VST3");
  1168. }
  1169. //==============================================================================
  1170. EnabledModuleList& Project::getModules()
  1171. {
  1172. if (enabledModulesList == nullptr)
  1173. enabledModulesList = new EnabledModuleList (*this, projectRoot.getOrCreateChildWithName (Ids::MODULES, nullptr));
  1174. return *enabledModulesList;
  1175. }
  1176. //==============================================================================
  1177. ValueTree Project::getExporters()
  1178. {
  1179. return projectRoot.getOrCreateChildWithName (Ids::EXPORTFORMATS, nullptr);
  1180. }
  1181. int Project::getNumExporters()
  1182. {
  1183. return getExporters().getNumChildren();
  1184. }
  1185. ProjectExporter* Project::createExporter (int index)
  1186. {
  1187. jassert (index >= 0 && index < getNumExporters());
  1188. return ProjectExporter::createExporter (*this, getExporters().getChild (index));
  1189. }
  1190. void Project::addNewExporter (const String& exporterName)
  1191. {
  1192. ScopedPointer<ProjectExporter> exp (ProjectExporter::createNewExporter (*this, exporterName));
  1193. exp->getTargetLocationValue() = exp->getTargetLocationString()
  1194. + getUniqueTargetFolderSuffixForExporter (exp->getName(), exp->getTargetLocationString());
  1195. auto exportersTree = getExporters();
  1196. exportersTree.addChild (exp->settings, -1, getUndoManagerFor (exportersTree));
  1197. }
  1198. void Project::createExporterForCurrentPlatform()
  1199. {
  1200. addNewExporter (ProjectExporter::getCurrentPlatformExporterName());
  1201. }
  1202. String Project::getUniqueTargetFolderSuffixForExporter (const String& exporterName, const String& base)
  1203. {
  1204. StringArray buildFolders;
  1205. auto exportersTree = getExporters();
  1206. auto type = ProjectExporter::getValueTreeNameForExporter (exporterName);
  1207. for (int i = 0; i < exportersTree.getNumChildren(); ++i)
  1208. {
  1209. auto exporterNode = exportersTree.getChild (i);
  1210. if (exporterNode.getType() == Identifier (type))
  1211. buildFolders.add (exporterNode.getProperty ("targetFolder").toString());
  1212. }
  1213. if (buildFolders.size() == 0 || ! buildFolders.contains (base))
  1214. return {};
  1215. buildFolders.remove (buildFolders.indexOf (base));
  1216. auto num = 1;
  1217. for (auto f : buildFolders)
  1218. {
  1219. if (! f.endsWith ("_" + String (num)))
  1220. break;
  1221. ++num;
  1222. }
  1223. return "_" + String (num);
  1224. }
  1225. //==============================================================================
  1226. String Project::getFileTemplate (const String& templateName)
  1227. {
  1228. int dataSize;
  1229. if (const char* data = BinaryData::getNamedResource (templateName.toUTF8(), dataSize))
  1230. return String::fromUTF8 (data, dataSize);
  1231. jassertfalse;
  1232. return {};
  1233. }
  1234. //==============================================================================
  1235. Project::ExporterIterator::ExporterIterator (Project& p) : index (-1), project (p) {}
  1236. Project::ExporterIterator::~ExporterIterator() {}
  1237. bool Project::ExporterIterator::next()
  1238. {
  1239. if (++index >= project.getNumExporters())
  1240. return false;
  1241. exporter = project.createExporter (index);
  1242. if (exporter == nullptr)
  1243. {
  1244. jassertfalse; // corrupted project file?
  1245. return next();
  1246. }
  1247. return true;
  1248. }