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.

982 lines
36KB

  1. /*
  2. ==============================================================================
  3. This file is part of the JUCE library - "Jules' Utility Class Extensions"
  4. Copyright 2004-10 by Raw Material Software Ltd.
  5. ------------------------------------------------------------------------------
  6. JUCE can be redistributed and/or modified under the terms of the GNU General
  7. Public License (Version 2), as published by the Free Software Foundation.
  8. A copy of the license is included in the JUCE distribution, or can be found
  9. online at www.gnu.org/licenses.
  10. JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  11. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12. A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  13. ------------------------------------------------------------------------------
  14. To release a closed-source product which uses JUCE, commercial licenses are
  15. available: visit www.rawmaterialsoftware.com/juce for more information.
  16. ==============================================================================
  17. */
  18. #include "jucer_Project.h"
  19. #include "jucer_ProjectExporter.h"
  20. #include "jucer_ResourceFile.h"
  21. #include "jucer_ProjectSaver.h"
  22. #include "../../ui/jucer_OpenDocumentManager.h"
  23. //==============================================================================
  24. namespace Tags
  25. {
  26. const Identifier projectRoot ("JUCERPROJECT");
  27. const Identifier projectMainGroup ("MAINGROUP");
  28. const Identifier group ("GROUP");
  29. const Identifier file ("FILE");
  30. const Identifier configurations ("CONFIGURATIONS");
  31. const Identifier configuration ("CONFIGURATION");
  32. const Identifier exporters ("EXPORTFORMATS");
  33. const Identifier configGroup ("JUCEOPTIONS");
  34. }
  35. const char* Project::projectFileExtension = ".jucer";
  36. //==============================================================================
  37. Project::Project (const File& file_)
  38. : FileBasedDocument (projectFileExtension,
  39. String ("*") + projectFileExtension,
  40. "Choose a Jucer project to load",
  41. "Save Jucer project"),
  42. projectRoot (Tags::projectRoot)
  43. {
  44. setFile (file_);
  45. setMissingDefaultValues();
  46. setChangedFlag (false);
  47. projectRoot.addListener (this);
  48. }
  49. Project::~Project()
  50. {
  51. projectRoot.removeListener (this);
  52. OpenDocumentManager::getInstance()->closeAllDocumentsUsingProject (*this, false);
  53. }
  54. //==============================================================================
  55. void Project::setTitle (const String& newTitle)
  56. {
  57. projectRoot.setProperty (Ids::name, newTitle, getUndoManagerFor (projectRoot));
  58. getMainGroup().getName() = newTitle;
  59. }
  60. const String Project::getDocumentTitle()
  61. {
  62. return getProjectName().toString();
  63. }
  64. void Project::updateProjectSettings()
  65. {
  66. projectRoot.setProperty (Ids::jucerVersion, ProjectInfo::versionString, 0);
  67. projectRoot.setProperty (Ids::name, getDocumentTitle(), 0);
  68. }
  69. void Project::setMissingDefaultValues()
  70. {
  71. if (! projectRoot.hasProperty (Ids::id_))
  72. projectRoot.setProperty (Ids::id_, createAlphaNumericUID(), 0);
  73. // Create main file group if missing
  74. if (! projectRoot.getChildWithName (Tags::projectMainGroup).isValid())
  75. {
  76. Item mainGroup (*this, ValueTree (Tags::projectMainGroup));
  77. projectRoot.addChild (mainGroup.getNode(), 0, 0);
  78. }
  79. getMainGroup().initialiseNodeValues();
  80. if (getDocumentTitle().isEmpty())
  81. setTitle ("Juce Project");
  82. if (! projectRoot.hasProperty (Ids::projectType))
  83. getProjectType() = (int) application;
  84. if (! projectRoot.hasProperty (Ids::version))
  85. getVersion() = "1.0.0";
  86. if (! projectRoot.hasProperty (Ids::juceLinkage))
  87. getJuceLinkageModeValue() = useAmalgamatedJuceViaMultipleTemplates;
  88. const String juceFolderPath (getRelativePathForFile (StoredSettings::getInstance()->getLastKnownJuceFolder()));
  89. // Create configs group
  90. if (! projectRoot.getChildWithName (Tags::configurations).isValid())
  91. {
  92. projectRoot.addChild (ValueTree (Tags::configurations), 0, 0);
  93. createDefaultConfigs();
  94. }
  95. if (! projectRoot.getChildWithName (Tags::exporters).isValid())
  96. createDefaultExporters();
  97. const String sanitisedProjectName (CodeHelpers::makeValidIdentifier (getProjectName().toString(), false, true, false));
  98. if (! projectRoot.hasProperty (Ids::buildVST))
  99. {
  100. shouldBuildVST() = true;
  101. shouldBuildRTAS() = false;
  102. shouldBuildAU() = true;
  103. getPluginName() = getProjectName().toString();
  104. getPluginDesc() = getProjectName().toString();
  105. getPluginManufacturer() = "yourcompany";
  106. getPluginManufacturerCode() = "abcd";
  107. getPluginCode() = "Abcd";
  108. getPluginChannelConfigs() = "{1, 1}, {2, 2}";
  109. getPluginIsSynth() = false;
  110. getPluginWantsMidiInput() = false;
  111. getPluginProducesMidiOut() = false;
  112. getPluginSilenceInProducesSilenceOut() = false;
  113. getPluginTailLengthSeconds() = 0;
  114. getPluginEditorNeedsKeyFocus() = false;
  115. getPluginAUExportPrefix() = sanitisedProjectName + "AU";
  116. getPluginAUCocoaViewClassName() = sanitisedProjectName + "AU_V1";
  117. getPluginRTASCategory() = String::empty;
  118. }
  119. if (! projectRoot.hasProperty (Ids::bundleIdentifier))
  120. setBundleIdentifierToDefault();
  121. }
  122. //==============================================================================
  123. const String Project::loadDocument (const File& file)
  124. {
  125. XmlDocument doc (file);
  126. ScopedPointer <XmlElement> xml (doc.getDocumentElement());
  127. if (xml == 0 || ! xml->hasTagName (Tags::projectRoot.toString()))
  128. return "Not a valid Jucer project!";
  129. ValueTree newTree (ValueTree::fromXml (*xml));
  130. if (! newTree.hasType (Tags::projectRoot))
  131. return "The document contains errors and couldn't be parsed!";
  132. StoredSettings::getInstance()->recentFiles.addFile (file);
  133. StoredSettings::getInstance()->flush();
  134. projectRoot = newTree;
  135. setMissingDefaultValues();
  136. return String::empty;
  137. }
  138. const String Project::saveDocument (const File& file)
  139. {
  140. updateProjectSettings();
  141. {
  142. // (getting these forces the values to be sanitised)
  143. OwnedArray <Project::JuceConfigFlag> flags;
  144. getJuceConfigFlags (flags);
  145. }
  146. if (FileHelpers::isJuceFolder (getLocalJuceFolder()))
  147. StoredSettings::getInstance()->setLastKnownJuceFolder (getLocalJuceFolder().getFullPathName());
  148. StoredSettings::getInstance()->recentFiles.addFile (file);
  149. ProjectSaver saver (*this, file);
  150. return saver.save();
  151. }
  152. //==============================================================================
  153. File Project::lastDocumentOpened;
  154. const File Project::getLastDocumentOpened()
  155. {
  156. return lastDocumentOpened;
  157. }
  158. void Project::setLastDocumentOpened (const File& file)
  159. {
  160. lastDocumentOpened = file;
  161. }
  162. //==============================================================================
  163. void Project::valueTreePropertyChanged (ValueTree& tree, const Identifier& property)
  164. {
  165. if (isLibrary())
  166. getJuceLinkageModeValue() = notLinkedToJuce;
  167. changed();
  168. }
  169. void Project::valueTreeChildrenChanged (ValueTree& tree)
  170. {
  171. changed();
  172. }
  173. void Project::valueTreeParentChanged (ValueTree& tree)
  174. {
  175. }
  176. //==============================================================================
  177. const File Project::resolveFilename (const String& filename) const
  178. {
  179. if (filename.isEmpty())
  180. return File::nonexistent;
  181. if (File::isAbsolutePath (filename))
  182. return File (filename);
  183. return getFile().getSiblingFile (filename);
  184. }
  185. const String Project::getRelativePathForFile (const File& file) const
  186. {
  187. String filename (file.getFullPathName());
  188. File relativePathBase (getFile().getParentDirectory());
  189. String p1 (relativePathBase.getFullPathName());
  190. String p2 (file.getFullPathName());
  191. while (p1.startsWithChar (File::separator))
  192. p1 = p1.substring (1);
  193. while (p2.startsWithChar (File::separator))
  194. p2 = p2.substring (1);
  195. if (p1.upToFirstOccurrenceOf (File::separatorString, true, false)
  196. .equalsIgnoreCase (p2.upToFirstOccurrenceOf (File::separatorString, true, false)))
  197. {
  198. filename = file.getRelativePathFrom (relativePathBase);
  199. }
  200. return filename;
  201. }
  202. //==============================================================================
  203. bool Project::shouldBeAddedToBinaryResourcesByDefault (const File& file)
  204. {
  205. return ! file.hasFileExtension (sourceFileExtensions);
  206. }
  207. //==============================================================================
  208. const char* const Project::application = "guiapp";
  209. const char* const Project::commandLineApp = "consoleapp";
  210. const char* const Project::audioPlugin = "audioplug";
  211. const char* const Project::library = "library";
  212. const char* const Project::browserPlugin = "browserplug";
  213. bool Project::isLibrary() const { return getProjectType().toString() == library; }
  214. bool Project::isGUIApplication() const { return getProjectType().toString() == application; }
  215. bool Project::isCommandLineApp() const { return getProjectType().toString() == commandLineApp; }
  216. bool Project::isAudioPlugin() const { return getProjectType().toString() == audioPlugin; }
  217. bool Project::isBrowserPlugin() const { return getProjectType().toString() == browserPlugin; }
  218. const char* const Project::notLinkedToJuce = "none";
  219. const char* const Project::useLinkedJuce = "static";
  220. const char* const Project::useAmalgamatedJuce = "amalg_big";
  221. const char* const Project::useAmalgamatedJuceViaSingleTemplate = "amalg_template";
  222. const char* const Project::useAmalgamatedJuceViaMultipleTemplates = "amalg_multi";
  223. const File Project::getLocalJuceFolder()
  224. {
  225. ScopedPointer <ProjectExporter> exp (ProjectExporter::createPlatformDefaultExporter (*this));
  226. if (exp != 0)
  227. {
  228. File f (resolveFilename (exp->getJuceFolder().toString()));
  229. if (FileHelpers::isJuceFolder (f))
  230. return f;
  231. }
  232. return StoredSettings::getInstance()->getLastKnownJuceFolder();
  233. }
  234. //==============================================================================
  235. void Project::createPropertyEditors (Array <PropertyComponent*>& props)
  236. {
  237. props.add (new TextPropertyComponent (getProjectName(), "Project Name", 256, false));
  238. props.getLast()->setTooltip ("The name of the project.");
  239. props.add (new TextPropertyComponent (getVersion(), "Project Version", 16, false));
  240. props.getLast()->setTooltip ("The project's version number, This should be in the format major.minor.point");
  241. const char* projectTypes[] = { "Application (GUI)", "Application (Non-GUI)", "Audio Plug-in", "Static Library", 0 };
  242. const char* projectTypeValues[] = { application, commandLineApp, audioPlugin, library, 0 };
  243. props.add (new ChoicePropertyComponent (getProjectType(), "Project Type", StringArray (projectTypes), Array<var> (projectTypeValues)));
  244. const char* linkageTypes[] = { "Not linked to Juce", "Linked to Juce Static Library", "Include Juce Amalgamated Files", "Include Juce Source Code Directly (In a single file)", "Include Juce Source Code Directly (Split across several files)", 0 };
  245. const char* linkageTypeValues[] = { notLinkedToJuce, useLinkedJuce, useAmalgamatedJuce, useAmalgamatedJuceViaSingleTemplate, useAmalgamatedJuceViaMultipleTemplates, 0 };
  246. props.add (new ChoicePropertyComponent (getJuceLinkageModeValue(), "Juce Linkage Method", StringArray (linkageTypes), Array<var> (linkageTypeValues)));
  247. props.getLast()->setTooltip ("The method by which your project will be linked to Juce.");
  248. props.add (new TextPropertyComponent (getBundleIdentifier(), "Bundle Identifier", 256, false));
  249. props.getLast()->setTooltip ("A unique identifier for this product, mainly for use in Mac builds. It should be something like 'com.yourcompanyname.yourproductname'");
  250. if (isAudioPlugin())
  251. {
  252. props.add (new BooleanPropertyComponent (shouldBuildVST(), "Build VST", "Enabled"));
  253. props.getLast()->setTooltip ("Whether the project should produce a VST plugin.");
  254. props.add (new BooleanPropertyComponent (shouldBuildAU(), "Build AudioUnit", "Enabled"));
  255. props.getLast()->setTooltip ("Whether the project should produce an AudioUnit plugin.");
  256. props.add (new BooleanPropertyComponent (shouldBuildRTAS(), "Build RTAS", "Enabled"));
  257. props.getLast()->setTooltip ("Whether the project should produce an RTAS plugin.");
  258. }
  259. if (isAudioPlugin())
  260. {
  261. props.add (new TextPropertyComponent (getPluginName(), "Plugin Name", 128, false));
  262. props.getLast()->setTooltip ("The name of your plugin (keep it short!)");
  263. props.add (new TextPropertyComponent (getPluginDesc(), "Plugin Description", 256, false));
  264. props.getLast()->setTooltip ("A short description of your plugin.");
  265. props.add (new TextPropertyComponent (getPluginManufacturer(), "Plugin Manufacturer", 256, false));
  266. props.getLast()->setTooltip ("The name of your company (cannot be blank).");
  267. props.add (new TextPropertyComponent (getPluginManufacturerCode(), "Plugin Manufacturer Code", 4, false));
  268. props.getLast()->setTooltip ("A four-character unique ID for your company.");
  269. props.add (new TextPropertyComponent (getPluginCode(), "Plugin Code", 4, false));
  270. props.getLast()->setTooltip ("A four-character unique ID for your plugin. Note that for AU compatibility, this must contain at least one upper-case letter!");
  271. props.add (new TextPropertyComponent (getPluginChannelConfigs(), "Plugin Channel Configurations", 256, false));
  272. props.getLast()->setTooltip ("This is the set of input/output channel configurations that your plugin can handle. The list is a comma-separated set of pairs of values in the form { numInputs, numOutputs }, and each "
  273. "pair indicates a valid configuration that the plugin can handle. So for example, {1, 1}, {2, 2} means that the plugin can be used in just two configurations: either with 1 input "
  274. "and 1 output, or with 2 inputs and 2 outputs.");
  275. props.add (new BooleanPropertyComponent (getPluginIsSynth(), "Plugin is a Synth", "Is a Synth"));
  276. props.getLast()->setTooltip ("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.");
  277. props.add (new BooleanPropertyComponent (getPluginWantsMidiInput(), "Plugin Midi Input", "Plugin wants midi input"));
  278. props.getLast()->setTooltip ("Enable this if you want your plugin to accept midi messages.");
  279. props.add (new BooleanPropertyComponent (getPluginProducesMidiOut(), "Plugin Midi Output", "Plugin produces midi output"));
  280. props.getLast()->setTooltip ("Enable this if your plugin is going to produce midi messages.");
  281. props.add (new BooleanPropertyComponent (getPluginSilenceInProducesSilenceOut(), "Silence", "Silence in produces silence out"));
  282. props.getLast()->setTooltip ("Enable this if your plugin has no tail - i.e. if passing a silent buffer to it will always result in a silent buffer being produced.");
  283. props.add (new TextPropertyComponent (getPluginTailLengthSeconds(), "Tail Length (in seconds)", 12, false));
  284. props.getLast()->setTooltip ("This indicates the length, in seconds, of the plugin's tail. This information may or may not be used by the host.");
  285. props.add (new BooleanPropertyComponent (getPluginEditorNeedsKeyFocus(), "Key Focus", "Plugin editor requires keyboard focus"));
  286. props.getLast()->setTooltip ("Enable this if your plugin needs keyboard input - some hosts can be a bit funny about keyboard focus..");
  287. props.add (new TextPropertyComponent (getPluginAUExportPrefix(), "Plugin AU Export Prefix", 64, false));
  288. props.getLast()->setTooltip ("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.");
  289. props.add (new TextPropertyComponent (getPluginAUCocoaViewClassName(), "Plugin AU Cocoa View Name", 64, false));
  290. props.getLast()->setTooltip ("In an AU, this is the name of Cocoa class that creates the UI. Some hosts bizarrely display the class-name, so you might want to make it reflect your plugin. But the name must be "
  291. "UNIQUE to this exact version of your plugin, to avoid objective-C linkage mix-ups that happen when different plugins containing the same class-name are loaded simultaneously.");
  292. props.add (new TextPropertyComponent (getPluginRTASCategory(), "Plugin RTAS Category", 64, false));
  293. props.getLast()->setTooltip ("(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, "
  294. "ePlugInCategory_PitchShift, ePlugInCategory_Reverb, ePlugInCategory_Delay, "
  295. "ePlugInCategory_Modulation, ePlugInCategory_Harmonic, ePlugInCategory_NoiseReduction, "
  296. "ePlugInCategory_Dither, ePlugInCategory_SoundField");
  297. }
  298. for (int i = props.size(); --i >= 0;)
  299. props.getUnchecked(i)->setPreferredHeight (22);
  300. }
  301. //==============================================================================
  302. Project::Item Project::getMainGroup()
  303. {
  304. return Item (*this, projectRoot.getChildWithName (Tags::projectMainGroup));
  305. }
  306. Project::Item Project::createNewGroup()
  307. {
  308. Item item (*this, ValueTree (Tags::group));
  309. item.initialiseNodeValues();
  310. item.getName() = "New Group";
  311. return item;
  312. }
  313. Project::Item Project::createNewItem (const File& file)
  314. {
  315. Item item (*this, ValueTree (Tags::file));
  316. item.initialiseNodeValues();
  317. item.getName() = file.getFileName();
  318. item.getShouldCompileValue() = file.hasFileExtension ("cpp;mm;c;m");
  319. item.getShouldAddToResourceValue() = shouldBeAddedToBinaryResourcesByDefault (file);
  320. return item;
  321. }
  322. //==============================================================================
  323. Project::Item::Item (Project& project_, const ValueTree& node_)
  324. : project (project_), node (node_)
  325. {
  326. }
  327. Project::Item::Item (const Item& other)
  328. : project (other.project), node (other.node)
  329. {
  330. }
  331. Project::Item::~Item()
  332. {
  333. }
  334. const String Project::Item::getID() const { return node [Ids::id_]; }
  335. bool Project::Item::isFile() const { return node.hasType (Tags::file); }
  336. bool Project::Item::isGroup() const { return node.hasType (Tags::group) || isMainGroup(); }
  337. bool Project::Item::isMainGroup() const { return node.hasType (Tags::projectMainGroup); }
  338. Project::Item Project::Item::findItemWithID (const String& targetId) const
  339. {
  340. if (node [Ids::id_] == targetId)
  341. return *this;
  342. if (isGroup())
  343. {
  344. for (int i = getNumChildren(); --i >= 0;)
  345. {
  346. Item found (getChild(i).findItemWithID (targetId));
  347. if (found.isValid())
  348. return found;
  349. }
  350. }
  351. return Item (project, ValueTree::invalid);
  352. }
  353. bool Project::Item::canContain (const Item& child) const
  354. {
  355. if (isFile())
  356. return false;
  357. if (isGroup())
  358. return child.isFile() || child.isGroup();
  359. jassertfalse
  360. return false;
  361. }
  362. bool Project::Item::shouldBeAddedToTargetProject() const
  363. {
  364. return isFile();
  365. }
  366. bool Project::Item::shouldBeCompiled() const
  367. {
  368. return getShouldCompileValue().getValue();
  369. }
  370. Value Project::Item::getShouldCompileValue() const
  371. {
  372. return node.getPropertyAsValue (Ids::compile, getUndoManager());
  373. }
  374. bool Project::Item::shouldBeAddedToBinaryResources() const
  375. {
  376. return getShouldAddToResourceValue().getValue();
  377. }
  378. Value Project::Item::getShouldAddToResourceValue() const
  379. {
  380. return node.getPropertyAsValue (Ids::resource, getUndoManager());
  381. }
  382. const File Project::Item::getFile() const
  383. {
  384. if (isFile())
  385. return project.resolveFilename (node [Ids::file].toString());
  386. else
  387. return File::nonexistent;
  388. }
  389. void Project::Item::setFile (const File& file)
  390. {
  391. jassert (isFile());
  392. node.setProperty (Ids::file, project.getRelativePathForFile (file), getUndoManager());
  393. node.setProperty (Ids::name, file.getFileName(), getUndoManager());
  394. jassert (getFile() == file);
  395. }
  396. bool Project::Item::renameFile (const File& newFile)
  397. {
  398. const File oldFile (getFile());
  399. if (oldFile.moveFileTo (newFile))
  400. {
  401. setFile (newFile);
  402. OpenDocumentManager::getInstance()->fileHasBeenRenamed (oldFile, newFile);
  403. return true;
  404. }
  405. return false;
  406. }
  407. Project::Item Project::Item::findItemForFile (const File& file) const
  408. {
  409. if (getFile() == file)
  410. return *this;
  411. if (isGroup())
  412. {
  413. for (int i = getNumChildren(); --i >= 0;)
  414. {
  415. Item found (getChild(i).findItemForFile (file));
  416. if (found.isValid())
  417. return found;
  418. }
  419. }
  420. return Item (project, ValueTree::invalid);
  421. }
  422. const File Project::Item::determineGroupFolder() const
  423. {
  424. jassert (isGroup());
  425. File f;
  426. for (int i = 0; i < getNumChildren(); ++i)
  427. {
  428. f = getChild(i).getFile();
  429. if (f.exists())
  430. return f.getParentDirectory();
  431. }
  432. Item parent (getParent());
  433. if (parent != *this)
  434. {
  435. f = parent.determineGroupFolder();
  436. if (f.getChildFile (getName().toString()).isDirectory())
  437. f = f.getChildFile (getName().toString());
  438. }
  439. else
  440. {
  441. f = project.getFile().getParentDirectory();
  442. if (f.getChildFile ("Source").isDirectory())
  443. f = f.getChildFile ("Source");
  444. }
  445. return f;
  446. }
  447. void Project::Item::initialiseNodeValues()
  448. {
  449. if (! node.hasProperty (Ids::id_))
  450. node.setProperty (Ids::id_, createAlphaNumericUID(), 0);
  451. if (isFile())
  452. {
  453. node.setProperty (Ids::name, getFile().getFileName(), 0);
  454. }
  455. else if (isGroup())
  456. {
  457. for (int i = getNumChildren(); --i >= 0;)
  458. getChild(i).initialiseNodeValues();
  459. }
  460. }
  461. Value Project::Item::getName() const
  462. {
  463. return node.getPropertyAsValue (Ids::name, getUndoManager());
  464. }
  465. void Project::Item::addChild (const Item& newChild, int insertIndex)
  466. {
  467. node.addChild (newChild.getNode(), insertIndex, getUndoManager());
  468. }
  469. void Project::Item::removeItemFromProject()
  470. {
  471. node.getParent().removeChild (node, getUndoManager());
  472. }
  473. Project::Item Project::Item::getParent() const
  474. {
  475. if (isMainGroup() || ! isGroup())
  476. return *this;
  477. return Item (project, node.getParent());
  478. }
  479. struct ItemSorter
  480. {
  481. static int compareElements (const ValueTree& first, const ValueTree& second)
  482. {
  483. return first [Ids::name].toString().compareIgnoreCase (second [Ids::name].toString());
  484. }
  485. };
  486. void Project::Item::sortAlphabetically()
  487. {
  488. ItemSorter sorter;
  489. node.sort (sorter);
  490. }
  491. bool Project::Item::addFile (const File& file, int insertIndex)
  492. {
  493. if (file == File::nonexistent || file.isHidden() || file.getFileName().startsWithChar ('.'))
  494. return false;
  495. if (file.isDirectory())
  496. {
  497. Item group (project.createNewGroup());
  498. group.getName() = file.getFileNameWithoutExtension();
  499. jassert (canContain (group));
  500. addChild (group, insertIndex);
  501. //group.setFile (file);
  502. DirectoryIterator iter (file, false, "*", File::findFilesAndDirectories);
  503. while (iter.next())
  504. group.addFile (iter.getFile(), -1);
  505. group.sortAlphabetically();
  506. }
  507. else if (file.existsAsFile())
  508. {
  509. Item item (project.createNewItem (file));
  510. if (canContain (item))
  511. {
  512. item.setFile (file);
  513. addChild (item, insertIndex);
  514. }
  515. }
  516. else
  517. {
  518. jassertfalse;
  519. }
  520. return true;
  521. }
  522. Image* Project::Item::getIcon() const
  523. {
  524. if (isFile())
  525. return LookAndFeel::getDefaultLookAndFeel().getDefaultDocumentFileImage();
  526. else if (isMainGroup())
  527. return ImageCache::getFromMemory (BinaryData::juce_icon_png, BinaryData::juce_icon_pngSize);
  528. else
  529. return LookAndFeel::getDefaultLookAndFeel().getDefaultFolderImage();
  530. }
  531. //==============================================================================
  532. ValueTree Project::getJuceConfigNode()
  533. {
  534. ValueTree configNode = projectRoot.getChildWithName (Tags::configGroup);
  535. if (! configNode.isValid())
  536. {
  537. configNode = ValueTree (Tags::configGroup);
  538. projectRoot.addChild (configNode, -1, 0);
  539. }
  540. return configNode;
  541. }
  542. void Project::getJuceConfigFlags (OwnedArray <JuceConfigFlag>& flags)
  543. {
  544. ValueTree configNode (getJuceConfigNode());
  545. File juceConfigH (getLocalJuceFolder().getChildFile ("juce_Config.h"));
  546. StringArray lines;
  547. lines.addLines (juceConfigH.loadFileAsString());
  548. for (int i = 0; i < lines.size(); ++i)
  549. {
  550. String line (lines[i].trim());
  551. if (line.startsWith ("/** ") && line.containsChar (':'))
  552. {
  553. ScopedPointer <JuceConfigFlag> config (new JuceConfigFlag());
  554. config->symbol = line.substring (4).upToFirstOccurrenceOf (":", false, false).trim();
  555. if (config->symbol.length() > 4)
  556. {
  557. config->description = line.fromFirstOccurrenceOf (":", false, false).trimStart();
  558. ++i;
  559. while (! (lines[i].contains ("*/") || lines[i].contains ("@see")))
  560. {
  561. if (lines[i].trim().isNotEmpty())
  562. config->description = config->description.trim() + " " + lines[i].trim();
  563. ++i;
  564. }
  565. config->description = config->description.upToFirstOccurrenceOf ("*/", false, false);
  566. config->value.referTo (getJuceConfigFlag (config->symbol));
  567. flags.add (config.release());
  568. }
  569. }
  570. }
  571. }
  572. const char* const Project::configFlagDefault = "default";
  573. const char* const Project::configFlagEnabled = "enabled";
  574. const char* const Project::configFlagDisabled = "disabled";
  575. Value Project::getJuceConfigFlag (const String& name)
  576. {
  577. const ValueTree configNode (getJuceConfigNode());
  578. Value v (configNode.getPropertyAsValue (name, getUndoManagerFor (configNode)));
  579. if (v.getValue().toString().isEmpty())
  580. v = configFlagDefault;
  581. return v;
  582. }
  583. //==============================================================================
  584. ValueTree Project::getConfigurations() const
  585. {
  586. return projectRoot.getChildWithName (Tags::configurations);
  587. }
  588. int Project::getNumConfigurations() const
  589. {
  590. return getConfigurations().getNumChildren();
  591. }
  592. Project::BuildConfiguration Project::getConfiguration (int index)
  593. {
  594. jassert (index < getConfigurations().getNumChildren());
  595. return BuildConfiguration (this, getConfigurations().getChild (index));
  596. }
  597. bool Project::hasConfigurationNamed (const String& name) const
  598. {
  599. const ValueTree configs (getConfigurations());
  600. for (int i = configs.getNumChildren(); --i >= 0;)
  601. if (configs.getChild(i) [Ids::name].toString() == name)
  602. return true;
  603. return false;
  604. }
  605. const String Project::getUniqueConfigName (String name) const
  606. {
  607. String nameRoot (name);
  608. while (CharacterFunctions::isDigit (nameRoot.getLastCharacter()))
  609. nameRoot = nameRoot.dropLastCharacters (1);
  610. nameRoot = nameRoot.trim();
  611. int suffix = 2;
  612. while (hasConfigurationNamed (name))
  613. name = nameRoot + " " + String (suffix++);
  614. return name;
  615. }
  616. void Project::addNewConfiguration (BuildConfiguration* configToCopy)
  617. {
  618. const String configName (getUniqueConfigName (configToCopy != 0 ? configToCopy->config [Ids::name].toString()
  619. : "New Build Configuration"));
  620. ValueTree configs (getConfigurations());
  621. if (! configs.isValid())
  622. {
  623. projectRoot.addChild (ValueTree (Tags::configurations), 0, getUndoManagerFor (projectRoot));
  624. configs = getConfigurations();
  625. }
  626. ValueTree newConfig (Tags::configuration);
  627. if (configToCopy != 0)
  628. newConfig = configToCopy->config.createCopy();
  629. newConfig.setProperty (Ids::name, configName, 0);
  630. configs.addChild (newConfig, -1, getUndoManagerFor (configs));
  631. }
  632. void Project::deleteConfiguration (int index)
  633. {
  634. ValueTree configs (getConfigurations());
  635. configs.removeChild (index, getUndoManagerFor (getConfigurations()));
  636. }
  637. void Project::createDefaultConfigs()
  638. {
  639. for (int i = 0; i < 2; ++i)
  640. {
  641. addNewConfiguration (0);
  642. BuildConfiguration config = getConfiguration (i);
  643. const bool debugConfig = i == 0;
  644. config.getName() = debugConfig ? "Debug" : "Release";
  645. config.isDebug() = debugConfig;
  646. config.getOptimisationLevel() = debugConfig ? 1 : 2;
  647. config.getTargetBinaryName() = getProjectFilenameRoot();
  648. }
  649. }
  650. //==============================================================================
  651. Project::BuildConfiguration::BuildConfiguration (Project* project_, const ValueTree& configNode)
  652. : project (project_),
  653. config (configNode)
  654. {
  655. }
  656. Project::BuildConfiguration::BuildConfiguration (const BuildConfiguration& other)
  657. : project (other.project),
  658. config (other.config)
  659. {
  660. }
  661. const Project::BuildConfiguration& Project::BuildConfiguration::operator= (const BuildConfiguration& other)
  662. {
  663. project = other.project;
  664. config = other.config;
  665. return *this;
  666. }
  667. Project::BuildConfiguration::~BuildConfiguration()
  668. {
  669. }
  670. const String Project::BuildConfiguration::getGCCOptimisationFlag() const
  671. {
  672. const int level = (int) getOptimisationLevel().getValue();
  673. return String (level <= 1 ? "0" : (level == 2 ? "s" : "3"));
  674. }
  675. const char* const Project::BuildConfiguration::osxVersionDefault = "default";
  676. const char* const Project::BuildConfiguration::osxVersion10_4 = "10.4 SDK";
  677. const char* const Project::BuildConfiguration::osxVersion10_5 = "10.5 SDK";
  678. const char* const Project::BuildConfiguration::osxVersion10_6 = "10.6 SDK";
  679. void Project::BuildConfiguration::createPropertyEditors (Array <PropertyComponent*>& props)
  680. {
  681. props.add (new TextPropertyComponent (getName(), "Name", 96, false));
  682. props.getLast()->setTooltip ("The name of this configuration.");
  683. props.add (new BooleanPropertyComponent (isDebug(), "Debug mode", "Debugging enabled"));
  684. props.getLast()->setTooltip ("If enabled, this means that the configuration should be built with debug synbols.");
  685. const char* optimisationLevels[] = { "No optimisation", "Optimise for size and speed", "Optimise for maximum speed", 0 };
  686. const int optimisationLevelValues[] = { 1, 2, 3, 0 };
  687. props.add (new ChoicePropertyComponent (getOptimisationLevel(), "Optimisation", StringArray (optimisationLevels), Array<var> (optimisationLevelValues)));
  688. props.getLast()->setTooltip ("The optimisation level for this configuration");
  689. props.add (new TextPropertyComponent (getTargetBinaryName(), "Binary name", 256, false));
  690. props.getLast()->setTooltip ("The filename to use for the destination binary executable file. Don't add a suffix to this, because platform-specific suffixes will be added for each target platform.");
  691. props.add (new TextPropertyComponent (getTargetBinaryRelativePath(), "Binary location", 1024, false));
  692. props.getLast()->setTooltip ("The folder in which the finished binary should be placed. Leave this blank to cause the binary to be placed in its default location in the build folder.");
  693. props.add (new TextPropertyComponent (getHeaderSearchPath(), "Header search path", 16384, false));
  694. props.getLast()->setTooltip ("Extra header search paths. Use semi-colons to separate multiple paths.");
  695. props.add (new TextPropertyComponent (getPreprocessorDefs(), "Preprocessor definitions", 32768, false));
  696. props.getLast()->setTooltip ("Extra preprocessor definitions. Use whitespace or commas as a delimiter.");
  697. if (getMacSDKVersion().toString().isEmpty())
  698. getMacSDKVersion() = osxVersionDefault;
  699. const char* osxVersions[] = { "Use Default", osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  700. const char* osxVersionValues[] = { osxVersionDefault, osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  701. props.add (new ChoicePropertyComponent (getMacSDKVersion(), "OSX Base SDK Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  702. props.getLast()->setTooltip ("The version of OSX to link against in the XCode build.");
  703. if (getMacCompatibilityVersion().toString().isEmpty())
  704. getMacCompatibilityVersion() = osxVersionDefault;
  705. props.add (new ChoicePropertyComponent (getMacCompatibilityVersion(), "OSX Compatibility Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  706. props.getLast()->setTooltip ("The minimum version of OSX that the target binary will be compatible with.");
  707. for (int i = props.size(); --i >= 0;)
  708. props.getUnchecked(i)->setPreferredHeight (22);
  709. }
  710. const StringArray Project::BuildConfiguration::parsePreprocessorDefs() const
  711. {
  712. StringArray defines;
  713. defines.addTokens (getPreprocessorDefs().toString(), " ,;", String::empty);
  714. defines.removeEmptyStrings (true);
  715. return defines;
  716. }
  717. const StringArray Project::BuildConfiguration::getHeaderSearchPaths() const
  718. {
  719. StringArray s;
  720. s.addTokens (getHeaderSearchPath().toString(), ";", String::empty);
  721. return s;
  722. }
  723. //==============================================================================
  724. ValueTree Project::getExporters()
  725. {
  726. ValueTree exporters (projectRoot.getChildWithName (Tags::exporters));
  727. if (! exporters.isValid())
  728. {
  729. projectRoot.addChild (ValueTree (Tags::exporters), 0, getUndoManagerFor (projectRoot));
  730. exporters = getExporters();
  731. }
  732. return exporters;
  733. }
  734. int Project::getNumExporters()
  735. {
  736. return getExporters().getNumChildren();
  737. }
  738. ProjectExporter* Project::createExporter (int index)
  739. {
  740. jassert (index >= 0 && index < getNumExporters());
  741. return ProjectExporter::createExporter (*this, getExporters().getChild (index));
  742. }
  743. void Project::addNewExporter (int exporterIndex)
  744. {
  745. ScopedPointer<ProjectExporter> exp (ProjectExporter::createNewExporter (*this, exporterIndex));
  746. ValueTree exporters (getExporters());
  747. exporters.addChild (exp->getSettings(), -1, getUndoManagerFor (exporters));
  748. }
  749. void Project::deleteExporter (int index)
  750. {
  751. ValueTree exporters (getExporters());
  752. exporters.removeChild (index, getUndoManagerFor (exporters));
  753. }
  754. void Project::createDefaultExporters()
  755. {
  756. ValueTree exporters (getExporters());
  757. exporters.removeAllChildren (getUndoManagerFor (exporters));
  758. for (int i = 0; i < ProjectExporter::getNumExporters(); ++i)
  759. addNewExporter (i);
  760. }
  761. //==============================================================================
  762. const String Project::getFileTemplate (const String& templateName)
  763. {
  764. int dataSize;
  765. const char* data = BinaryData::getNamedResource (templateName.toUTF8(), dataSize);
  766. if (data == 0)
  767. {
  768. jassertfalse;
  769. return String::empty;
  770. }
  771. return String::fromUTF8 (data, dataSize);
  772. }