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.

1089 lines
39KB

  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 "../Application/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() = 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() = "Manu";
  107. getPluginCode() = "Plug";
  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. {
  251. OwnedArray<Project::Item> images;
  252. findAllImageItems (images);
  253. StringArray choices;
  254. Array<var> ids;
  255. choices.add ("<None>");
  256. ids.add (var::null);
  257. choices.add (String::empty);
  258. ids.add (var::null);
  259. for (int i = 0; i < images.size(); ++i)
  260. {
  261. choices.add (images.getUnchecked(i)->getName().toString());
  262. ids.add (images.getUnchecked(i)->getID());
  263. }
  264. props.add (new ChoicePropertyComponent (getSmallIconImageItemID(), "Icon (small)", choices, ids));
  265. props.getLast()->setTooltip ("Sets an icon to use for the executable.");
  266. props.add (new ChoicePropertyComponent (getBigIconImageItemID(), "Icon (large)", choices, ids));
  267. props.getLast()->setTooltip ("Sets an icon to use for the executable.");
  268. }
  269. props.add (new TextPropertyComponent (getObjectiveCClassSuffix(), "Objective-C Name Suffix", 256, false));
  270. props.getLast()->setTooltip ("An optional string which will be appended to objective-C class names. If you're building a plugin, it's important to define this, to avoid name clashes between multiple plugin modules that are dynamically loaded into the same address space.");
  271. if (isAudioPlugin())
  272. {
  273. props.add (new BooleanPropertyComponent (shouldBuildVST(), "Build VST", "Enabled"));
  274. props.getLast()->setTooltip ("Whether the project should produce a VST plugin.");
  275. props.add (new BooleanPropertyComponent (shouldBuildAU(), "Build AudioUnit", "Enabled"));
  276. props.getLast()->setTooltip ("Whether the project should produce an AudioUnit plugin.");
  277. props.add (new BooleanPropertyComponent (shouldBuildRTAS(), "Build RTAS", "Enabled"));
  278. props.getLast()->setTooltip ("Whether the project should produce an RTAS plugin.");
  279. }
  280. if (isAudioPlugin())
  281. {
  282. props.add (new TextPropertyComponent (getPluginName(), "Plugin Name", 128, false));
  283. props.getLast()->setTooltip ("The name of your plugin (keep it short!)");
  284. props.add (new TextPropertyComponent (getPluginDesc(), "Plugin Description", 256, false));
  285. props.getLast()->setTooltip ("A short description of your plugin.");
  286. props.add (new TextPropertyComponent (getPluginManufacturer(), "Plugin Manufacturer", 256, false));
  287. props.getLast()->setTooltip ("The name of your company (cannot be blank).");
  288. props.add (new TextPropertyComponent (getPluginManufacturerCode(), "Plugin Manufacturer Code", 4, false));
  289. props.getLast()->setTooltip ("A four-character unique ID for your company. Note that for AU compatibility, this must contain at least one upper-case letter!");
  290. props.add (new TextPropertyComponent (getPluginCode(), "Plugin Code", 4, false));
  291. 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!");
  292. props.add (new TextPropertyComponent (getPluginChannelConfigs(), "Plugin Channel Configurations", 256, false));
  293. 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 "
  294. "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 "
  295. "and 1 output, or with 2 inputs and 2 outputs.");
  296. props.add (new BooleanPropertyComponent (getPluginIsSynth(), "Plugin is a Synth", "Is a Synth"));
  297. 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.");
  298. props.add (new BooleanPropertyComponent (getPluginWantsMidiInput(), "Plugin Midi Input", "Plugin wants midi input"));
  299. props.getLast()->setTooltip ("Enable this if you want your plugin to accept midi messages.");
  300. props.add (new BooleanPropertyComponent (getPluginProducesMidiOut(), "Plugin Midi Output", "Plugin produces midi output"));
  301. props.getLast()->setTooltip ("Enable this if your plugin is going to produce midi messages.");
  302. props.add (new BooleanPropertyComponent (getPluginSilenceInProducesSilenceOut(), "Silence", "Silence in produces silence out"));
  303. 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.");
  304. props.add (new TextPropertyComponent (getPluginTailLengthSeconds(), "Tail Length (in seconds)", 12, false));
  305. 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.");
  306. props.add (new BooleanPropertyComponent (getPluginEditorNeedsKeyFocus(), "Key Focus", "Plugin editor requires keyboard focus"));
  307. props.getLast()->setTooltip ("Enable this if your plugin needs keyboard input - some hosts can be a bit funny about keyboard focus..");
  308. props.add (new TextPropertyComponent (getPluginAUExportPrefix(), "Plugin AU Export Prefix", 64, false));
  309. 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.");
  310. props.add (new TextPropertyComponent (getPluginAUCocoaViewClassName(), "Plugin AU Cocoa View Name", 64, false));
  311. 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 "
  312. "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.");
  313. props.add (new TextPropertyComponent (getPluginRTASCategory(), "Plugin RTAS Category", 64, false));
  314. 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, "
  315. "ePlugInCategory_PitchShift, ePlugInCategory_Reverb, ePlugInCategory_Delay, "
  316. "ePlugInCategory_Modulation, ePlugInCategory_Harmonic, ePlugInCategory_NoiseReduction, "
  317. "ePlugInCategory_Dither, ePlugInCategory_SoundField");
  318. }
  319. for (int i = props.size(); --i >= 0;)
  320. props.getUnchecked(i)->setPreferredHeight (22);
  321. }
  322. const Image Project::getBigIcon()
  323. {
  324. Item icon (getMainGroup().findItemWithID (getBigIconImageItemID().toString()));
  325. if (icon.isValid())
  326. return ImageCache::getFromFile (icon.getFile());
  327. return Image();
  328. }
  329. const Image Project::getSmallIcon()
  330. {
  331. Item icon (getMainGroup().findItemWithID (getSmallIconImageItemID().toString()));
  332. if (icon.isValid())
  333. return ImageCache::getFromFile (icon.getFile());
  334. return Image();
  335. }
  336. //==============================================================================
  337. Project::Item Project::getMainGroup()
  338. {
  339. return Item (*this, projectRoot.getChildWithName (Tags::projectMainGroup));
  340. }
  341. Project::Item Project::createNewGroup()
  342. {
  343. Item item (*this, ValueTree (Tags::group));
  344. item.initialiseNodeValues();
  345. item.getName() = "New Group";
  346. return item;
  347. }
  348. Project::Item Project::createNewItem (const File& file)
  349. {
  350. Item item (*this, ValueTree (Tags::file));
  351. item.initialiseNodeValues();
  352. item.getName() = file.getFileName();
  353. item.getShouldCompileValue() = file.hasFileExtension ("cpp;mm;c;m");
  354. item.getShouldAddToResourceValue() = shouldBeAddedToBinaryResourcesByDefault (file);
  355. return item;
  356. }
  357. static void findImages (const Project::Item& item, OwnedArray<Project::Item>& found)
  358. {
  359. if (item.isFile())
  360. {
  361. if (item.getFile().hasFileExtension ("png;jpg;jpeg;gif"))
  362. found.add (new Project::Item (item));
  363. }
  364. else if (item.isGroup())
  365. {
  366. for (int i = 0; i < item.getNumChildren(); ++i)
  367. findImages (item.getChild (i), found);
  368. }
  369. }
  370. void Project::findAllImageItems (OwnedArray<Project::Item>& items)
  371. {
  372. findImages (getMainGroup(), items);
  373. }
  374. //==============================================================================
  375. Project::Item::Item (Project& project_, const ValueTree& node_)
  376. : project (project_), node (node_)
  377. {
  378. }
  379. Project::Item::Item (const Item& other)
  380. : project (other.project), node (other.node)
  381. {
  382. }
  383. Project::Item::~Item()
  384. {
  385. }
  386. const String Project::Item::getID() const { return node [Ids::id_]; }
  387. const String Project::Item::getImageFileID() const { return "id:" + getID(); }
  388. bool Project::Item::isFile() const { return node.hasType (Tags::file); }
  389. bool Project::Item::isGroup() const { return node.hasType (Tags::group) || isMainGroup(); }
  390. bool Project::Item::isMainGroup() const { return node.hasType (Tags::projectMainGroup); }
  391. Project::Item Project::Item::findItemWithID (const String& targetId) const
  392. {
  393. if (node [Ids::id_] == targetId)
  394. return *this;
  395. if (isGroup())
  396. {
  397. for (int i = getNumChildren(); --i >= 0;)
  398. {
  399. Item found (getChild(i).findItemWithID (targetId));
  400. if (found.isValid())
  401. return found;
  402. }
  403. }
  404. return Item (project, ValueTree::invalid);
  405. }
  406. bool Project::Item::canContain (const Item& child) const
  407. {
  408. if (isFile())
  409. return false;
  410. if (isGroup())
  411. return child.isFile() || child.isGroup();
  412. jassertfalse
  413. return false;
  414. }
  415. bool Project::Item::shouldBeAddedToTargetProject() const
  416. {
  417. return isFile();
  418. }
  419. bool Project::Item::shouldBeCompiled() const
  420. {
  421. return getShouldCompileValue().getValue();
  422. }
  423. Value Project::Item::getShouldCompileValue() const
  424. {
  425. return node.getPropertyAsValue (Ids::compile, getUndoManager());
  426. }
  427. bool Project::Item::shouldBeAddedToBinaryResources() const
  428. {
  429. return getShouldAddToResourceValue().getValue();
  430. }
  431. Value Project::Item::getShouldAddToResourceValue() const
  432. {
  433. return node.getPropertyAsValue (Ids::resource, getUndoManager());
  434. }
  435. const File Project::Item::getFile() const
  436. {
  437. if (isFile())
  438. return project.resolveFilename (node [Ids::file].toString());
  439. else
  440. return File::nonexistent;
  441. }
  442. void Project::Item::setFile (const File& file)
  443. {
  444. jassert (isFile());
  445. node.setProperty (Ids::file, project.getRelativePathForFile (file), getUndoManager());
  446. node.setProperty (Ids::name, file.getFileName(), getUndoManager());
  447. jassert (getFile() == file);
  448. }
  449. bool Project::Item::renameFile (const File& newFile)
  450. {
  451. const File oldFile (getFile());
  452. if (oldFile.moveFileTo (newFile))
  453. {
  454. setFile (newFile);
  455. OpenDocumentManager::getInstance()->fileHasBeenRenamed (oldFile, newFile);
  456. return true;
  457. }
  458. return false;
  459. }
  460. Project::Item Project::Item::findItemForFile (const File& file) const
  461. {
  462. if (getFile() == file)
  463. return *this;
  464. if (isGroup())
  465. {
  466. for (int i = getNumChildren(); --i >= 0;)
  467. {
  468. Item found (getChild(i).findItemForFile (file));
  469. if (found.isValid())
  470. return found;
  471. }
  472. }
  473. return Item (project, ValueTree::invalid);
  474. }
  475. const File Project::Item::determineGroupFolder() const
  476. {
  477. jassert (isGroup());
  478. File f;
  479. for (int i = 0; i < getNumChildren(); ++i)
  480. {
  481. f = getChild(i).getFile();
  482. if (f.exists())
  483. return f.getParentDirectory();
  484. }
  485. Item parent (getParent());
  486. if (parent != *this)
  487. {
  488. f = parent.determineGroupFolder();
  489. if (f.getChildFile (getName().toString()).isDirectory())
  490. f = f.getChildFile (getName().toString());
  491. }
  492. else
  493. {
  494. f = project.getFile().getParentDirectory();
  495. if (f.getChildFile ("Source").isDirectory())
  496. f = f.getChildFile ("Source");
  497. }
  498. return f;
  499. }
  500. void Project::Item::initialiseNodeValues()
  501. {
  502. if (! node.hasProperty (Ids::id_))
  503. node.setProperty (Ids::id_, createAlphaNumericUID(), 0);
  504. if (isFile())
  505. {
  506. node.setProperty (Ids::name, getFile().getFileName(), 0);
  507. }
  508. else if (isGroup())
  509. {
  510. for (int i = getNumChildren(); --i >= 0;)
  511. getChild(i).initialiseNodeValues();
  512. }
  513. }
  514. Value Project::Item::getName() const
  515. {
  516. return node.getPropertyAsValue (Ids::name, getUndoManager());
  517. }
  518. void Project::Item::addChild (const Item& newChild, int insertIndex)
  519. {
  520. node.addChild (newChild.getNode(), insertIndex, getUndoManager());
  521. }
  522. void Project::Item::removeItemFromProject()
  523. {
  524. node.getParent().removeChild (node, getUndoManager());
  525. }
  526. Project::Item Project::Item::getParent() const
  527. {
  528. if (isMainGroup() || ! isGroup())
  529. return *this;
  530. return Item (project, node.getParent());
  531. }
  532. struct ItemSorter
  533. {
  534. static int compareElements (const ValueTree& first, const ValueTree& second)
  535. {
  536. return first [Ids::name].toString().compareIgnoreCase (second [Ids::name].toString());
  537. }
  538. };
  539. void Project::Item::sortAlphabetically()
  540. {
  541. ItemSorter sorter;
  542. node.sort (sorter);
  543. }
  544. bool Project::Item::addFile (const File& file, int insertIndex)
  545. {
  546. if (file == File::nonexistent || file.isHidden() || file.getFileName().startsWithChar ('.'))
  547. return false;
  548. if (file.isDirectory())
  549. {
  550. Item group (project.createNewGroup());
  551. group.getName() = file.getFileNameWithoutExtension();
  552. jassert (canContain (group));
  553. addChild (group, insertIndex);
  554. //group.setFile (file);
  555. DirectoryIterator iter (file, false, "*", File::findFilesAndDirectories);
  556. while (iter.next())
  557. {
  558. if (! project.getMainGroup().findItemForFile (iter.getFile()).isValid())
  559. group.addFile (iter.getFile(), -1);
  560. }
  561. group.sortAlphabetically();
  562. }
  563. else if (file.existsAsFile())
  564. {
  565. if (! project.getMainGroup().findItemForFile (file).isValid())
  566. {
  567. Item item (project.createNewItem (file));
  568. if (canContain (item))
  569. {
  570. item.setFile (file);
  571. addChild (item, insertIndex);
  572. }
  573. }
  574. }
  575. else
  576. {
  577. jassertfalse;
  578. }
  579. return true;
  580. }
  581. const Image Project::Item::getIcon() const
  582. {
  583. if (isFile())
  584. return LookAndFeel::getDefaultLookAndFeel().getDefaultDocumentFileImage();
  585. else if (isMainGroup())
  586. return ImageCache::getFromMemory (BinaryData::juce_icon_png, BinaryData::juce_icon_pngSize);
  587. else
  588. return LookAndFeel::getDefaultLookAndFeel().getDefaultFolderImage();
  589. }
  590. //==============================================================================
  591. ValueTree Project::getJuceConfigNode()
  592. {
  593. ValueTree configNode = projectRoot.getChildWithName (Tags::configGroup);
  594. if (! configNode.isValid())
  595. {
  596. configNode = ValueTree (Tags::configGroup);
  597. projectRoot.addChild (configNode, -1, 0);
  598. }
  599. return configNode;
  600. }
  601. void Project::getJuceConfigFlags (OwnedArray <JuceConfigFlag>& flags)
  602. {
  603. ValueTree configNode (getJuceConfigNode());
  604. File juceConfigH (getLocalJuceFolder().getChildFile ("juce_Config.h"));
  605. StringArray lines;
  606. lines.addLines (juceConfigH.loadFileAsString());
  607. for (int i = 0; i < lines.size(); ++i)
  608. {
  609. String line (lines[i].trim());
  610. if (line.startsWith ("/** ") && line.containsChar (':'))
  611. {
  612. ScopedPointer <JuceConfigFlag> config (new JuceConfigFlag());
  613. config->symbol = line.substring (4).upToFirstOccurrenceOf (":", false, false).trim();
  614. if (config->symbol.length() > 4)
  615. {
  616. config->description = line.fromFirstOccurrenceOf (":", false, false).trimStart();
  617. ++i;
  618. while (! (lines[i].contains ("*/") || lines[i].contains ("@see")))
  619. {
  620. if (lines[i].trim().isNotEmpty())
  621. config->description = config->description.trim() + " " + lines[i].trim();
  622. ++i;
  623. }
  624. config->description = config->description.upToFirstOccurrenceOf ("*/", false, false);
  625. config->value.referTo (getJuceConfigFlag (config->symbol));
  626. flags.add (config.release());
  627. }
  628. }
  629. }
  630. }
  631. const char* const Project::configFlagDefault = "default";
  632. const char* const Project::configFlagEnabled = "enabled";
  633. const char* const Project::configFlagDisabled = "disabled";
  634. Value Project::getJuceConfigFlag (const String& name)
  635. {
  636. const ValueTree configNode (getJuceConfigNode());
  637. Value v (configNode.getPropertyAsValue (name, getUndoManagerFor (configNode)));
  638. if (v.getValue().toString().isEmpty())
  639. v = configFlagDefault;
  640. return v;
  641. }
  642. //==============================================================================
  643. ValueTree Project::getConfigurations() const
  644. {
  645. return projectRoot.getChildWithName (Tags::configurations);
  646. }
  647. int Project::getNumConfigurations() const
  648. {
  649. return getConfigurations().getNumChildren();
  650. }
  651. Project::BuildConfiguration Project::getConfiguration (int index)
  652. {
  653. jassert (index < getConfigurations().getNumChildren());
  654. return BuildConfiguration (this, getConfigurations().getChild (index));
  655. }
  656. bool Project::hasConfigurationNamed (const String& name) const
  657. {
  658. const ValueTree configs (getConfigurations());
  659. for (int i = configs.getNumChildren(); --i >= 0;)
  660. if (configs.getChild(i) [Ids::name].toString() == name)
  661. return true;
  662. return false;
  663. }
  664. const String Project::getUniqueConfigName (String name) const
  665. {
  666. String nameRoot (name);
  667. while (CharacterFunctions::isDigit (nameRoot.getLastCharacter()))
  668. nameRoot = nameRoot.dropLastCharacters (1);
  669. nameRoot = nameRoot.trim();
  670. int suffix = 2;
  671. while (hasConfigurationNamed (name))
  672. name = nameRoot + " " + String (suffix++);
  673. return name;
  674. }
  675. void Project::addNewConfiguration (BuildConfiguration* configToCopy)
  676. {
  677. const String configName (getUniqueConfigName (configToCopy != 0 ? configToCopy->config [Ids::name].toString()
  678. : "New Build Configuration"));
  679. ValueTree configs (getConfigurations());
  680. if (! configs.isValid())
  681. {
  682. projectRoot.addChild (ValueTree (Tags::configurations), 0, getUndoManagerFor (projectRoot));
  683. configs = getConfigurations();
  684. }
  685. ValueTree newConfig (Tags::configuration);
  686. if (configToCopy != 0)
  687. newConfig = configToCopy->config.createCopy();
  688. newConfig.setProperty (Ids::name, configName, 0);
  689. configs.addChild (newConfig, -1, getUndoManagerFor (configs));
  690. }
  691. void Project::deleteConfiguration (int index)
  692. {
  693. ValueTree configs (getConfigurations());
  694. configs.removeChild (index, getUndoManagerFor (getConfigurations()));
  695. }
  696. void Project::createDefaultConfigs()
  697. {
  698. for (int i = 0; i < 2; ++i)
  699. {
  700. addNewConfiguration (0);
  701. BuildConfiguration config = getConfiguration (i);
  702. const bool debugConfig = i == 0;
  703. config.getName() = debugConfig ? "Debug" : "Release";
  704. config.isDebug() = debugConfig;
  705. config.getOptimisationLevel() = debugConfig ? 1 : 2;
  706. config.getTargetBinaryName() = getProjectFilenameRoot();
  707. }
  708. }
  709. //==============================================================================
  710. Project::BuildConfiguration::BuildConfiguration (Project* project_, const ValueTree& configNode)
  711. : project (project_),
  712. config (configNode)
  713. {
  714. }
  715. Project::BuildConfiguration::BuildConfiguration (const BuildConfiguration& other)
  716. : project (other.project),
  717. config (other.config)
  718. {
  719. }
  720. const Project::BuildConfiguration& Project::BuildConfiguration::operator= (const BuildConfiguration& other)
  721. {
  722. project = other.project;
  723. config = other.config;
  724. return *this;
  725. }
  726. Project::BuildConfiguration::~BuildConfiguration()
  727. {
  728. }
  729. const String Project::BuildConfiguration::getGCCOptimisationFlag() const
  730. {
  731. const int level = (int) getOptimisationLevel().getValue();
  732. return String (level <= 1 ? "0" : (level == 2 ? "s" : "3"));
  733. }
  734. const char* const Project::BuildConfiguration::osxVersionDefault = "default";
  735. const char* const Project::BuildConfiguration::osxVersion10_4 = "10.4 SDK";
  736. const char* const Project::BuildConfiguration::osxVersion10_5 = "10.5 SDK";
  737. const char* const Project::BuildConfiguration::osxVersion10_6 = "10.6 SDK";
  738. void Project::BuildConfiguration::createPropertyEditors (Array <PropertyComponent*>& props)
  739. {
  740. props.add (new TextPropertyComponent (getName(), "Name", 96, false));
  741. props.getLast()->setTooltip ("The name of this configuration.");
  742. props.add (new BooleanPropertyComponent (isDebug(), "Debug mode", "Debugging enabled"));
  743. props.getLast()->setTooltip ("If enabled, this means that the configuration should be built with debug synbols.");
  744. const char* optimisationLevels[] = { "No optimisation", "Optimise for size and speed", "Optimise for maximum speed", 0 };
  745. const int optimisationLevelValues[] = { 1, 2, 3, 0 };
  746. props.add (new ChoicePropertyComponent (getOptimisationLevel(), "Optimisation", StringArray (optimisationLevels), Array<var> (optimisationLevelValues)));
  747. props.getLast()->setTooltip ("The optimisation level for this configuration");
  748. props.add (new TextPropertyComponent (getTargetBinaryName(), "Binary name", 256, false));
  749. 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.");
  750. props.add (new TextPropertyComponent (getTargetBinaryRelativePath(), "Binary location", 1024, false));
  751. 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.");
  752. props.add (new TextPropertyComponent (getHeaderSearchPath(), "Header search path", 16384, false));
  753. props.getLast()->setTooltip ("Extra header search paths. Use semi-colons to separate multiple paths.");
  754. props.add (new TextPropertyComponent (getPreprocessorDefs(), "Preprocessor definitions", 32768, false));
  755. props.getLast()->setTooltip ("Extra preprocessor definitions. Use whitespace or commas as a delimiter.");
  756. if (getMacSDKVersion().toString().isEmpty())
  757. getMacSDKVersion() = osxVersionDefault;
  758. const char* osxVersions[] = { "Use Default", osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  759. const char* osxVersionValues[] = { osxVersionDefault, osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  760. props.add (new ChoicePropertyComponent (getMacSDKVersion(), "OSX Base SDK Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  761. props.getLast()->setTooltip ("The version of OSX to link against in the XCode build.");
  762. if (getMacCompatibilityVersion().toString().isEmpty())
  763. getMacCompatibilityVersion() = osxVersionDefault;
  764. props.add (new ChoicePropertyComponent (getMacCompatibilityVersion(), "OSX Compatibility Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  765. props.getLast()->setTooltip ("The minimum version of OSX that the target binary will be compatible with.");
  766. for (int i = props.size(); --i >= 0;)
  767. props.getUnchecked(i)->setPreferredHeight (22);
  768. }
  769. const StringArray Project::BuildConfiguration::parsePreprocessorDefs() const
  770. {
  771. StringArray defines;
  772. defines.addTokens (getPreprocessorDefs().toString(), " ,;", String::empty);
  773. defines.removeEmptyStrings (true);
  774. return defines;
  775. }
  776. const StringArray Project::BuildConfiguration::getHeaderSearchPaths() const
  777. {
  778. StringArray s;
  779. s.addTokens (getHeaderSearchPath().toString(), ";", String::empty);
  780. return s;
  781. }
  782. //==============================================================================
  783. ValueTree Project::getExporters()
  784. {
  785. ValueTree exporters (projectRoot.getChildWithName (Tags::exporters));
  786. if (! exporters.isValid())
  787. {
  788. projectRoot.addChild (ValueTree (Tags::exporters), 0, getUndoManagerFor (projectRoot));
  789. exporters = getExporters();
  790. }
  791. return exporters;
  792. }
  793. int Project::getNumExporters()
  794. {
  795. return getExporters().getNumChildren();
  796. }
  797. ProjectExporter* Project::createExporter (int index)
  798. {
  799. jassert (index >= 0 && index < getNumExporters());
  800. return ProjectExporter::createExporter (*this, getExporters().getChild (index));
  801. }
  802. void Project::addNewExporter (int exporterIndex)
  803. {
  804. ScopedPointer<ProjectExporter> exp (ProjectExporter::createNewExporter (*this, exporterIndex));
  805. ValueTree exporters (getExporters());
  806. exporters.addChild (exp->getSettings(), -1, getUndoManagerFor (exporters));
  807. }
  808. void Project::deleteExporter (int index)
  809. {
  810. ValueTree exporters (getExporters());
  811. exporters.removeChild (index, getUndoManagerFor (exporters));
  812. }
  813. void Project::createDefaultExporters()
  814. {
  815. ValueTree exporters (getExporters());
  816. exporters.removeAllChildren (getUndoManagerFor (exporters));
  817. for (int i = 0; i < ProjectExporter::getNumExporters(); ++i)
  818. addNewExporter (i);
  819. }
  820. //==============================================================================
  821. const String Project::getFileTemplate (const String& templateName)
  822. {
  823. int dataSize;
  824. const char* data = BinaryData::getNamedResource (templateName.toUTF8(), dataSize);
  825. if (data == 0)
  826. {
  827. jassertfalse;
  828. return String::empty;
  829. }
  830. return String::fromUTF8 (data, dataSize);
  831. }
  832. //==============================================================================
  833. void Project::resaveJucerFile (const File& file)
  834. {
  835. if (! file.exists())
  836. {
  837. std::cout << "The file " << file.getFullPathName() << " doesn't exist!" << std::endl;
  838. return;
  839. }
  840. if (! file.hasFileExtension (Project::projectFileExtension))
  841. {
  842. std::cout << file.getFullPathName() << " isn't a valid jucer project file!" << std::endl;
  843. return;
  844. }
  845. Project newDoc (file);
  846. if (! newDoc.loadFrom (file, true))
  847. {
  848. std::cout << "Failed to load the project file: " << file.getFullPathName() << std::endl;
  849. return;
  850. }
  851. std::cout << "The Jucer - Re-saving file: " << file.getFullPathName() << std::endl;
  852. String error (newDoc.saveDocument (file));
  853. if (error.isNotEmpty())
  854. {
  855. std::cout << "Error when writing project: " << error << std::endl;
  856. return;
  857. }
  858. }