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.

1102 lines
40KB

  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. mainProjectIcon.setImage (ImageCache::getFromMemory (BinaryData::juce_icon_png, BinaryData::juce_icon_pngSize));
  48. projectRoot.addListener (this);
  49. }
  50. Project::~Project()
  51. {
  52. projectRoot.removeListener (this);
  53. OpenDocumentManager::getInstance()->closeAllDocumentsUsingProject (*this, false);
  54. }
  55. //==============================================================================
  56. void Project::setTitle (const String& newTitle)
  57. {
  58. projectRoot.setProperty (Ids::name, newTitle, getUndoManagerFor (projectRoot));
  59. getMainGroup().getName() = newTitle;
  60. }
  61. const String Project::getDocumentTitle()
  62. {
  63. return getProjectName().toString();
  64. }
  65. void Project::updateProjectSettings()
  66. {
  67. projectRoot.setProperty (Ids::jucerVersion, ProjectInfo::versionString, 0);
  68. projectRoot.setProperty (Ids::name, getDocumentTitle(), 0);
  69. }
  70. void Project::setMissingDefaultValues()
  71. {
  72. if (! projectRoot.hasProperty (Ids::id_))
  73. projectRoot.setProperty (Ids::id_, createAlphaNumericUID(), 0);
  74. // Create main file group if missing
  75. if (! projectRoot.getChildWithName (Tags::projectMainGroup).isValid())
  76. {
  77. Item mainGroup (*this, ValueTree (Tags::projectMainGroup));
  78. projectRoot.addChild (mainGroup.getNode(), 0, 0);
  79. }
  80. getMainGroup().initialiseNodeValues();
  81. if (getDocumentTitle().isEmpty())
  82. setTitle ("Juce Project");
  83. if (! projectRoot.hasProperty (Ids::projectType))
  84. getProjectType() = application;
  85. if (! projectRoot.hasProperty (Ids::version))
  86. getVersion() = "1.0.0";
  87. if (! projectRoot.hasProperty (Ids::juceLinkage))
  88. getJuceLinkageModeValue() = useAmalgamatedJuceViaMultipleTemplates;
  89. const String juceFolderPath (getRelativePathForFile (StoredSettings::getInstance()->getLastKnownJuceFolder()));
  90. // Create configs group
  91. if (! projectRoot.getChildWithName (Tags::configurations).isValid())
  92. {
  93. projectRoot.addChild (ValueTree (Tags::configurations), 0, 0);
  94. createDefaultConfigs();
  95. }
  96. if (! projectRoot.getChildWithName (Tags::exporters).isValid())
  97. createDefaultExporters();
  98. const String sanitisedProjectName (CodeHelpers::makeValidIdentifier (getProjectName().toString(), false, true, false));
  99. if (! projectRoot.hasProperty (Ids::buildVST))
  100. {
  101. shouldBuildVST() = true;
  102. shouldBuildRTAS() = false;
  103. shouldBuildAU() = true;
  104. getPluginName() = getProjectName().toString();
  105. getPluginDesc() = getProjectName().toString();
  106. getPluginManufacturer() = "yourcompany";
  107. getPluginManufacturerCode() = "Manu";
  108. getPluginCode() = "Plug";
  109. getPluginChannelConfigs() = "{1, 1}, {2, 2}";
  110. getPluginIsSynth() = false;
  111. getPluginWantsMidiInput() = false;
  112. getPluginProducesMidiOut() = false;
  113. getPluginSilenceInProducesSilenceOut() = false;
  114. getPluginTailLengthSeconds() = 0;
  115. getPluginEditorNeedsKeyFocus() = false;
  116. getPluginAUExportPrefix() = sanitisedProjectName + "AU";
  117. getPluginAUCocoaViewClassName() = sanitisedProjectName + "AU_V1";
  118. getPluginRTASCategory() = String::empty;
  119. }
  120. if (! projectRoot.hasProperty (Ids::bundleIdentifier))
  121. setBundleIdentifierToDefault();
  122. }
  123. //==============================================================================
  124. const String Project::loadDocument (const File& file)
  125. {
  126. ScopedPointer <XmlElement> xml (XmlDocument::parse (file));
  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 (String filename) const
  178. {
  179. if (filename.isEmpty())
  180. return File::nonexistent;
  181. filename = replacePreprocessorDefs (getPreprocessorDefs(), filename);
  182. if (File::isAbsolutePath (filename))
  183. return File (filename);
  184. return getFile().getSiblingFile (filename);
  185. }
  186. const String Project::getRelativePathForFile (const File& file) const
  187. {
  188. String filename (file.getFullPathName());
  189. File relativePathBase (getFile().getParentDirectory());
  190. String p1 (relativePathBase.getFullPathName());
  191. String p2 (file.getFullPathName());
  192. while (p1.startsWithChar (File::separator))
  193. p1 = p1.substring (1);
  194. while (p2.startsWithChar (File::separator))
  195. p2 = p2.substring (1);
  196. if (p1.upToFirstOccurrenceOf (File::separatorString, true, false)
  197. .equalsIgnoreCase (p2.upToFirstOccurrenceOf (File::separatorString, true, false)))
  198. {
  199. filename = file.getRelativePathFrom (relativePathBase);
  200. }
  201. return filename;
  202. }
  203. //==============================================================================
  204. bool Project::shouldBeAddedToBinaryResourcesByDefault (const File& file)
  205. {
  206. return ! file.hasFileExtension (sourceOrHeaderFileExtensions);
  207. }
  208. //==============================================================================
  209. const char* const Project::application = "guiapp";
  210. const char* const Project::commandLineApp = "consoleapp";
  211. const char* const Project::audioPlugin = "audioplug";
  212. const char* const Project::library = "library";
  213. const char* const Project::browserPlugin = "browserplug";
  214. bool Project::isLibrary() const { return getProjectType().toString() == library; }
  215. bool Project::isGUIApplication() const { return getProjectType().toString() == application; }
  216. bool Project::isCommandLineApp() const { return getProjectType().toString() == commandLineApp; }
  217. bool Project::isAudioPlugin() const { return getProjectType().toString() == audioPlugin; }
  218. bool Project::isBrowserPlugin() const { return getProjectType().toString() == browserPlugin; }
  219. const char* const Project::notLinkedToJuce = "none";
  220. const char* const Project::useLinkedJuce = "static";
  221. const char* const Project::useAmalgamatedJuce = "amalg_big";
  222. const char* const Project::useAmalgamatedJuceViaSingleTemplate = "amalg_template";
  223. const char* const Project::useAmalgamatedJuceViaMultipleTemplates = "amalg_multi";
  224. const File Project::getLocalJuceFolder()
  225. {
  226. ScopedPointer <ProjectExporter> exp (ProjectExporter::createPlatformDefaultExporter (*this));
  227. if (exp != 0)
  228. {
  229. File f (resolveFilename (exp->getJuceFolder().toString()));
  230. if (FileHelpers::isJuceFolder (f))
  231. return f;
  232. }
  233. return StoredSettings::getInstance()->getLastKnownJuceFolder();
  234. }
  235. //==============================================================================
  236. void Project::createPropertyEditors (Array <PropertyComponent*>& props)
  237. {
  238. props.add (new TextPropertyComponent (getProjectName(), "Project Name", 256, false));
  239. props.getLast()->setTooltip ("The name of the project.");
  240. props.add (new TextPropertyComponent (getVersion(), "Project Version", 16, false));
  241. props.getLast()->setTooltip ("The project's version number, This should be in the format major.minor.point");
  242. const char* projectTypes[] = { "Application (GUI)", "Application (Non-GUI)", "Audio Plug-in", "Static Library", 0 };
  243. const char* projectTypeValues[] = { application, commandLineApp, audioPlugin, library, 0 };
  244. props.add (new ChoicePropertyComponent (getProjectType(), "Project Type", StringArray (projectTypes), Array<var> (projectTypeValues)));
  245. 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 };
  246. const char* linkageTypeValues[] = { notLinkedToJuce, useLinkedJuce, useAmalgamatedJuce, useAmalgamatedJuceViaSingleTemplate, useAmalgamatedJuceViaMultipleTemplates, 0 };
  247. props.add (new ChoicePropertyComponent (getJuceLinkageModeValue(), "Juce Linkage Method", StringArray (linkageTypes), Array<var> (linkageTypeValues)));
  248. props.getLast()->setTooltip ("The method by which your project will be linked to Juce.");
  249. props.add (new TextPropertyComponent (getBundleIdentifier(), "Bundle Identifier", 256, false));
  250. props.getLast()->setTooltip ("A unique identifier for this product, mainly for use in Mac builds. It should be something like 'com.yourcompanyname.yourproductname'");
  251. {
  252. OwnedArray<Project::Item> images;
  253. findAllImageItems (images);
  254. StringArray choices;
  255. Array<var> ids;
  256. choices.add ("<None>");
  257. ids.add (var::null);
  258. choices.add (String::empty);
  259. ids.add (var::null);
  260. for (int i = 0; i < images.size(); ++i)
  261. {
  262. choices.add (images.getUnchecked(i)->getName().toString());
  263. ids.add (images.getUnchecked(i)->getID());
  264. }
  265. props.add (new ChoicePropertyComponent (getSmallIconImageItemID(), "Icon (small)", choices, ids));
  266. props.getLast()->setTooltip ("Sets an icon to use for the executable.");
  267. props.add (new ChoicePropertyComponent (getBigIconImageItemID(), "Icon (large)", choices, ids));
  268. props.getLast()->setTooltip ("Sets an icon to use for the executable.");
  269. }
  270. if (isAudioPlugin())
  271. {
  272. props.add (new BooleanPropertyComponent (shouldBuildVST(), "Build VST", "Enabled"));
  273. props.getLast()->setTooltip ("Whether the project should produce a VST plugin.");
  274. props.add (new BooleanPropertyComponent (shouldBuildAU(), "Build AudioUnit", "Enabled"));
  275. props.getLast()->setTooltip ("Whether the project should produce an AudioUnit plugin.");
  276. props.add (new BooleanPropertyComponent (shouldBuildRTAS(), "Build RTAS", "Enabled"));
  277. props.getLast()->setTooltip ("Whether the project should produce an RTAS plugin.");
  278. }
  279. if (isAudioPlugin())
  280. {
  281. props.add (new TextPropertyComponent (getPluginName(), "Plugin Name", 128, false));
  282. props.getLast()->setTooltip ("The name of your plugin (keep it short!)");
  283. props.add (new TextPropertyComponent (getPluginDesc(), "Plugin Description", 256, false));
  284. props.getLast()->setTooltip ("A short description of your plugin.");
  285. props.add (new TextPropertyComponent (getPluginManufacturer(), "Plugin Manufacturer", 256, false));
  286. props.getLast()->setTooltip ("The name of your company (cannot be blank).");
  287. props.add (new TextPropertyComponent (getPluginManufacturerCode(), "Plugin Manufacturer Code", 4, false));
  288. 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!");
  289. props.add (new TextPropertyComponent (getPluginCode(), "Plugin Code", 4, false));
  290. 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!");
  291. props.add (new TextPropertyComponent (getPluginChannelConfigs(), "Plugin Channel Configurations", 256, false));
  292. 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 "
  293. "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 "
  294. "and 1 output, or with 2 inputs and 2 outputs.");
  295. props.add (new BooleanPropertyComponent (getPluginIsSynth(), "Plugin is a Synth", "Is a Synth"));
  296. 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.");
  297. props.add (new BooleanPropertyComponent (getPluginWantsMidiInput(), "Plugin Midi Input", "Plugin wants midi input"));
  298. props.getLast()->setTooltip ("Enable this if you want your plugin to accept midi messages.");
  299. props.add (new BooleanPropertyComponent (getPluginProducesMidiOut(), "Plugin Midi Output", "Plugin produces midi output"));
  300. props.getLast()->setTooltip ("Enable this if your plugin is going to produce midi messages.");
  301. props.add (new BooleanPropertyComponent (getPluginSilenceInProducesSilenceOut(), "Silence", "Silence in produces silence out"));
  302. 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.");
  303. props.add (new TextPropertyComponent (getPluginTailLengthSeconds(), "Tail Length (in seconds)", 12, false));
  304. 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.");
  305. props.add (new BooleanPropertyComponent (getPluginEditorNeedsKeyFocus(), "Key Focus", "Plugin editor requires keyboard focus"));
  306. props.getLast()->setTooltip ("Enable this if your plugin needs keyboard input - some hosts can be a bit funny about keyboard focus..");
  307. props.add (new TextPropertyComponent (getPluginAUExportPrefix(), "Plugin AU Export Prefix", 64, false));
  308. 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.");
  309. props.add (new TextPropertyComponent (getPluginAUCocoaViewClassName(), "Plugin AU Cocoa View Name", 64, false));
  310. 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 "
  311. "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.");
  312. props.add (new TextPropertyComponent (getPluginRTASCategory(), "Plugin RTAS Category", 64, false));
  313. 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, "
  314. "ePlugInCategory_PitchShift, ePlugInCategory_Reverb, ePlugInCategory_Delay, "
  315. "ePlugInCategory_Modulation, ePlugInCategory_Harmonic, ePlugInCategory_NoiseReduction, "
  316. "ePlugInCategory_Dither, ePlugInCategory_SoundField");
  317. }
  318. props.add (new TextPropertyComponent (getProjectPreprocessorDefs(), "Preprocessor definitions", 32768, false));
  319. props.getLast()->setTooltip ("Extra preprocessor definitions. Use the form \"NAME1=value NAME2=value\", using whitespace or commas to separate the items - to include a space or comma in a definition, precede it with a backslash.");
  320. for (int i = props.size(); --i >= 0;)
  321. props.getUnchecked(i)->setPreferredHeight (22);
  322. }
  323. const Image Project::getBigIcon()
  324. {
  325. Item icon (getMainGroup().findItemWithID (getBigIconImageItemID().toString()));
  326. if (icon.isValid())
  327. return ImageCache::getFromFile (icon.getFile());
  328. return Image();
  329. }
  330. const Image Project::getSmallIcon()
  331. {
  332. Item icon (getMainGroup().findItemWithID (getSmallIconImageItemID().toString()));
  333. if (icon.isValid())
  334. return ImageCache::getFromFile (icon.getFile());
  335. return Image();
  336. }
  337. const StringPairArray Project::getPreprocessorDefs() const
  338. {
  339. return parsePreprocessorDefs (getProjectPreprocessorDefs().toString());
  340. }
  341. //==============================================================================
  342. Project::Item Project::getMainGroup()
  343. {
  344. return Item (*this, projectRoot.getChildWithName (Tags::projectMainGroup));
  345. }
  346. Project::Item Project::createNewGroup()
  347. {
  348. Item item (*this, ValueTree (Tags::group));
  349. item.initialiseNodeValues();
  350. item.getName() = "New Group";
  351. return item;
  352. }
  353. Project::Item Project::createNewItem (const File& file)
  354. {
  355. Item item (*this, ValueTree (Tags::file));
  356. item.initialiseNodeValues();
  357. item.getName() = file.getFileName();
  358. item.getShouldCompileValue() = file.hasFileExtension ("cpp;mm;c;m;cc;cxx");
  359. item.getShouldAddToResourceValue() = shouldBeAddedToBinaryResourcesByDefault (file);
  360. return item;
  361. }
  362. static void findImages (const Project::Item& item, OwnedArray<Project::Item>& found)
  363. {
  364. if (item.isImageFile())
  365. {
  366. found.add (new Project::Item (item));
  367. }
  368. else if (item.isGroup())
  369. {
  370. for (int i = 0; i < item.getNumChildren(); ++i)
  371. findImages (item.getChild (i), found);
  372. }
  373. }
  374. void Project::findAllImageItems (OwnedArray<Project::Item>& items)
  375. {
  376. findImages (getMainGroup(), items);
  377. }
  378. //==============================================================================
  379. Project::Item::Item (Project& project_, const ValueTree& node_)
  380. : project (project_), node (node_)
  381. {
  382. }
  383. Project::Item::Item (const Item& other)
  384. : project (other.project), node (other.node)
  385. {
  386. }
  387. Project::Item::~Item()
  388. {
  389. }
  390. const String Project::Item::getID() const { return node [Ids::id_]; }
  391. const String Project::Item::getImageFileID() const { return "id:" + getID(); }
  392. bool Project::Item::isFile() const { return node.hasType (Tags::file); }
  393. bool Project::Item::isGroup() const { return node.hasType (Tags::group) || isMainGroup(); }
  394. bool Project::Item::isMainGroup() const { return node.hasType (Tags::projectMainGroup); }
  395. bool Project::Item::isImageFile() const { return isFile() && getFile().hasFileExtension ("png;jpg;jpeg;gif;drawable"); }
  396. Project::Item Project::Item::findItemWithID (const String& targetId) const
  397. {
  398. if (node [Ids::id_] == targetId)
  399. return *this;
  400. if (isGroup())
  401. {
  402. for (int i = getNumChildren(); --i >= 0;)
  403. {
  404. Item found (getChild(i).findItemWithID (targetId));
  405. if (found.isValid())
  406. return found;
  407. }
  408. }
  409. return Item (project, ValueTree::invalid);
  410. }
  411. bool Project::Item::canContain (const Item& child) const
  412. {
  413. if (isFile())
  414. return false;
  415. if (isGroup())
  416. return child.isFile() || child.isGroup();
  417. jassertfalse
  418. return false;
  419. }
  420. bool Project::Item::shouldBeAddedToTargetProject() const
  421. {
  422. return isFile();
  423. }
  424. bool Project::Item::shouldBeCompiled() const
  425. {
  426. return getShouldCompileValue().getValue();
  427. }
  428. Value Project::Item::getShouldCompileValue() const
  429. {
  430. return node.getPropertyAsValue (Ids::compile, getUndoManager());
  431. }
  432. bool Project::Item::shouldBeAddedToBinaryResources() const
  433. {
  434. return getShouldAddToResourceValue().getValue();
  435. }
  436. Value Project::Item::getShouldAddToResourceValue() const
  437. {
  438. return node.getPropertyAsValue (Ids::resource, getUndoManager());
  439. }
  440. const File Project::Item::getFile() const
  441. {
  442. if (isFile())
  443. return project.resolveFilename (node [Ids::file].toString());
  444. else
  445. return File::nonexistent;
  446. }
  447. void Project::Item::setFile (const File& file)
  448. {
  449. jassert (isFile());
  450. node.setProperty (Ids::file, project.getRelativePathForFile (file), getUndoManager());
  451. node.setProperty (Ids::name, file.getFileName(), getUndoManager());
  452. jassert (getFile() == file);
  453. }
  454. bool Project::Item::renameFile (const File& newFile)
  455. {
  456. const File oldFile (getFile());
  457. if (oldFile.moveFileTo (newFile))
  458. {
  459. setFile (newFile);
  460. OpenDocumentManager::getInstance()->fileHasBeenRenamed (oldFile, newFile);
  461. return true;
  462. }
  463. return false;
  464. }
  465. Project::Item Project::Item::findItemForFile (const File& file) const
  466. {
  467. if (getFile() == file)
  468. return *this;
  469. if (isGroup())
  470. {
  471. for (int i = getNumChildren(); --i >= 0;)
  472. {
  473. Item found (getChild(i).findItemForFile (file));
  474. if (found.isValid())
  475. return found;
  476. }
  477. }
  478. return Item (project, ValueTree::invalid);
  479. }
  480. const File Project::Item::determineGroupFolder() const
  481. {
  482. jassert (isGroup());
  483. File f;
  484. for (int i = 0; i < getNumChildren(); ++i)
  485. {
  486. f = getChild(i).getFile();
  487. if (f.exists())
  488. return f.getParentDirectory();
  489. }
  490. Item parent (getParent());
  491. if (parent != *this)
  492. {
  493. f = parent.determineGroupFolder();
  494. if (f.getChildFile (getName().toString()).isDirectory())
  495. f = f.getChildFile (getName().toString());
  496. }
  497. else
  498. {
  499. f = project.getFile().getParentDirectory();
  500. if (f.getChildFile ("Source").isDirectory())
  501. f = f.getChildFile ("Source");
  502. }
  503. return f;
  504. }
  505. void Project::Item::initialiseNodeValues()
  506. {
  507. if (! node.hasProperty (Ids::id_))
  508. node.setProperty (Ids::id_, createAlphaNumericUID(), 0);
  509. if (isFile())
  510. {
  511. node.setProperty (Ids::name, getFile().getFileName(), 0);
  512. }
  513. else if (isGroup())
  514. {
  515. for (int i = getNumChildren(); --i >= 0;)
  516. getChild(i).initialiseNodeValues();
  517. }
  518. }
  519. Value Project::Item::getName() const
  520. {
  521. return node.getPropertyAsValue (Ids::name, getUndoManager());
  522. }
  523. void Project::Item::addChild (const Item& newChild, int insertIndex)
  524. {
  525. node.addChild (newChild.getNode(), insertIndex, getUndoManager());
  526. }
  527. void Project::Item::removeItemFromProject()
  528. {
  529. node.getParent().removeChild (node, getUndoManager());
  530. }
  531. Project::Item Project::Item::getParent() const
  532. {
  533. if (isMainGroup() || ! isGroup())
  534. return *this;
  535. return Item (project, node.getParent());
  536. }
  537. struct ItemSorter
  538. {
  539. static int compareElements (const ValueTree& first, const ValueTree& second)
  540. {
  541. return first [Ids::name].toString().compareIgnoreCase (second [Ids::name].toString());
  542. }
  543. };
  544. void Project::Item::sortAlphabetically()
  545. {
  546. ItemSorter sorter;
  547. node.sort (sorter, getUndoManager(), true);
  548. }
  549. bool Project::Item::addFile (const File& file, int insertIndex)
  550. {
  551. if (file == File::nonexistent || file.isHidden() || file.getFileName().startsWithChar ('.'))
  552. return false;
  553. if (file.isDirectory())
  554. {
  555. Item group (project.createNewGroup());
  556. group.getName() = file.getFileNameWithoutExtension();
  557. jassert (canContain (group));
  558. addChild (group, insertIndex);
  559. //group.setFile (file);
  560. DirectoryIterator iter (file, false, "*", File::findFilesAndDirectories);
  561. while (iter.next())
  562. {
  563. if (! project.getMainGroup().findItemForFile (iter.getFile()).isValid())
  564. group.addFile (iter.getFile(), -1);
  565. }
  566. group.sortAlphabetically();
  567. }
  568. else if (file.existsAsFile())
  569. {
  570. if (! project.getMainGroup().findItemForFile (file).isValid())
  571. {
  572. Item item (project.createNewItem (file));
  573. if (canContain (item))
  574. {
  575. item.setFile (file);
  576. addChild (item, insertIndex);
  577. }
  578. }
  579. }
  580. else
  581. {
  582. jassertfalse;
  583. }
  584. return true;
  585. }
  586. const Drawable* Project::Item::getIcon() const
  587. {
  588. if (isFile())
  589. {
  590. if (isImageFile())
  591. return StoredSettings::getInstance()->getImageFileIcon();
  592. return LookAndFeel::getDefaultLookAndFeel().getDefaultDocumentFileImage();
  593. }
  594. else if (isMainGroup())
  595. {
  596. return &(getProject().mainProjectIcon);
  597. }
  598. return LookAndFeel::getDefaultLookAndFeel().getDefaultFolderImage();
  599. }
  600. //==============================================================================
  601. ValueTree Project::getJuceConfigNode()
  602. {
  603. ValueTree configNode = projectRoot.getChildWithName (Tags::configGroup);
  604. if (! configNode.isValid())
  605. {
  606. configNode = ValueTree (Tags::configGroup);
  607. projectRoot.addChild (configNode, -1, 0);
  608. }
  609. return configNode;
  610. }
  611. void Project::getJuceConfigFlags (OwnedArray <JuceConfigFlag>& flags)
  612. {
  613. ValueTree configNode (getJuceConfigNode());
  614. File juceConfigH (getLocalJuceFolder().getChildFile ("juce_Config.h"));
  615. StringArray lines;
  616. lines.addLines (juceConfigH.loadFileAsString());
  617. for (int i = 0; i < lines.size(); ++i)
  618. {
  619. String line (lines[i].trim());
  620. if (line.startsWith ("/** ") && line.containsChar (':'))
  621. {
  622. ScopedPointer <JuceConfigFlag> config (new JuceConfigFlag());
  623. config->symbol = line.substring (4).upToFirstOccurrenceOf (":", false, false).trim();
  624. if (config->symbol.length() > 4)
  625. {
  626. config->description = line.fromFirstOccurrenceOf (":", false, false).trimStart();
  627. ++i;
  628. while (! (lines[i].contains ("*/") || lines[i].contains ("@see")))
  629. {
  630. if (lines[i].trim().isNotEmpty())
  631. config->description = config->description.trim() + " " + lines[i].trim();
  632. ++i;
  633. }
  634. config->description = config->description.upToFirstOccurrenceOf ("*/", false, false);
  635. config->value.referTo (getJuceConfigFlag (config->symbol));
  636. flags.add (config.release());
  637. }
  638. }
  639. }
  640. }
  641. const char* const Project::configFlagDefault = "default";
  642. const char* const Project::configFlagEnabled = "enabled";
  643. const char* const Project::configFlagDisabled = "disabled";
  644. Value Project::getJuceConfigFlag (const String& name)
  645. {
  646. const ValueTree configNode (getJuceConfigNode());
  647. Value v (configNode.getPropertyAsValue (name, getUndoManagerFor (configNode)));
  648. if (v.getValue().toString().isEmpty())
  649. v = configFlagDefault;
  650. return v;
  651. }
  652. //==============================================================================
  653. ValueTree Project::getConfigurations() const
  654. {
  655. return projectRoot.getChildWithName (Tags::configurations);
  656. }
  657. int Project::getNumConfigurations() const
  658. {
  659. return getConfigurations().getNumChildren();
  660. }
  661. Project::BuildConfiguration Project::getConfiguration (int index)
  662. {
  663. jassert (index < getConfigurations().getNumChildren());
  664. return BuildConfiguration (this, getConfigurations().getChild (index));
  665. }
  666. bool Project::hasConfigurationNamed (const String& name) const
  667. {
  668. const ValueTree configs (getConfigurations());
  669. for (int i = configs.getNumChildren(); --i >= 0;)
  670. if (configs.getChild(i) [Ids::name].toString() == name)
  671. return true;
  672. return false;
  673. }
  674. const String Project::getUniqueConfigName (String name) const
  675. {
  676. String nameRoot (name);
  677. while (CharacterFunctions::isDigit (nameRoot.getLastCharacter()))
  678. nameRoot = nameRoot.dropLastCharacters (1);
  679. nameRoot = nameRoot.trim();
  680. int suffix = 2;
  681. while (hasConfigurationNamed (name))
  682. name = nameRoot + " " + String (suffix++);
  683. return name;
  684. }
  685. void Project::addNewConfiguration (BuildConfiguration* configToCopy)
  686. {
  687. const String configName (getUniqueConfigName (configToCopy != 0 ? configToCopy->config [Ids::name].toString()
  688. : "New Build Configuration"));
  689. ValueTree configs (getConfigurations());
  690. if (! configs.isValid())
  691. {
  692. projectRoot.addChild (ValueTree (Tags::configurations), 0, getUndoManagerFor (projectRoot));
  693. configs = getConfigurations();
  694. }
  695. ValueTree newConfig (Tags::configuration);
  696. if (configToCopy != 0)
  697. newConfig = configToCopy->config.createCopy();
  698. newConfig.setProperty (Ids::name, configName, 0);
  699. configs.addChild (newConfig, -1, getUndoManagerFor (configs));
  700. }
  701. void Project::deleteConfiguration (int index)
  702. {
  703. ValueTree configs (getConfigurations());
  704. configs.removeChild (index, getUndoManagerFor (getConfigurations()));
  705. }
  706. void Project::createDefaultConfigs()
  707. {
  708. for (int i = 0; i < 2; ++i)
  709. {
  710. addNewConfiguration (0);
  711. BuildConfiguration config = getConfiguration (i);
  712. const bool debugConfig = i == 0;
  713. config.getName() = debugConfig ? "Debug" : "Release";
  714. config.isDebug() = debugConfig;
  715. config.getOptimisationLevel() = debugConfig ? 1 : 2;
  716. config.getTargetBinaryName() = getProjectFilenameRoot();
  717. }
  718. }
  719. //==============================================================================
  720. Project::BuildConfiguration::BuildConfiguration (Project* project_, const ValueTree& configNode)
  721. : project (project_),
  722. config (configNode)
  723. {
  724. }
  725. Project::BuildConfiguration::BuildConfiguration (const BuildConfiguration& other)
  726. : project (other.project),
  727. config (other.config)
  728. {
  729. }
  730. const Project::BuildConfiguration& Project::BuildConfiguration::operator= (const BuildConfiguration& other)
  731. {
  732. project = other.project;
  733. config = other.config;
  734. return *this;
  735. }
  736. Project::BuildConfiguration::~BuildConfiguration()
  737. {
  738. }
  739. const String Project::BuildConfiguration::getGCCOptimisationFlag() const
  740. {
  741. const int level = (int) getOptimisationLevel().getValue();
  742. return String (level <= 1 ? "0" : (level == 2 ? "s" : "3"));
  743. }
  744. const char* const Project::BuildConfiguration::osxVersionDefault = "default";
  745. const char* const Project::BuildConfiguration::osxVersion10_4 = "10.4 SDK";
  746. const char* const Project::BuildConfiguration::osxVersion10_5 = "10.5 SDK";
  747. const char* const Project::BuildConfiguration::osxVersion10_6 = "10.6 SDK";
  748. void Project::BuildConfiguration::createPropertyEditors (Array <PropertyComponent*>& props)
  749. {
  750. props.add (new TextPropertyComponent (getName(), "Name", 96, false));
  751. props.getLast()->setTooltip ("The name of this configuration.");
  752. props.add (new BooleanPropertyComponent (isDebug(), "Debug mode", "Debugging enabled"));
  753. props.getLast()->setTooltip ("If enabled, this means that the configuration should be built with debug synbols.");
  754. const char* optimisationLevels[] = { "No optimisation", "Optimise for size and speed", "Optimise for maximum speed", 0 };
  755. const int optimisationLevelValues[] = { 1, 2, 3, 0 };
  756. props.add (new ChoicePropertyComponent (getOptimisationLevel(), "Optimisation", StringArray (optimisationLevels), Array<var> (optimisationLevelValues)));
  757. props.getLast()->setTooltip ("The optimisation level for this configuration");
  758. props.add (new TextPropertyComponent (getTargetBinaryName(), "Binary name", 256, false));
  759. 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.");
  760. props.add (new TextPropertyComponent (getTargetBinaryRelativePath(), "Binary location", 1024, false));
  761. 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.");
  762. props.add (new TextPropertyComponent (getHeaderSearchPath(), "Header search path", 16384, false));
  763. props.getLast()->setTooltip ("Extra header search paths. Use semi-colons to separate multiple paths.");
  764. props.add (new TextPropertyComponent (getBuildConfigPreprocessorDefs(), "Preprocessor definitions", 32768, false));
  765. props.getLast()->setTooltip ("Extra preprocessor definitions. Use the form \"NAME1=value NAME2=value\", using whitespace or commas to separate the items - to include a space or comma in a definition, precede it with a backslash.");
  766. if (getMacSDKVersion().toString().isEmpty())
  767. getMacSDKVersion() = osxVersionDefault;
  768. const char* osxVersions[] = { "Use Default", osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  769. const char* osxVersionValues[] = { osxVersionDefault, osxVersion10_4, osxVersion10_5, osxVersion10_6, 0 };
  770. props.add (new ChoicePropertyComponent (getMacSDKVersion(), "OSX Base SDK Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  771. props.getLast()->setTooltip ("The version of OSX to link against in the XCode build.");
  772. if (getMacCompatibilityVersion().toString().isEmpty())
  773. getMacCompatibilityVersion() = osxVersionDefault;
  774. props.add (new ChoicePropertyComponent (getMacCompatibilityVersion(), "OSX Compatibility Version", StringArray (osxVersions), Array<var> (osxVersionValues)));
  775. props.getLast()->setTooltip ("The minimum version of OSX that the target binary will be compatible with.");
  776. for (int i = props.size(); --i >= 0;)
  777. props.getUnchecked(i)->setPreferredHeight (22);
  778. }
  779. const StringPairArray Project::BuildConfiguration::getAllPreprocessorDefs() const
  780. {
  781. return mergePreprocessorDefs (project->getPreprocessorDefs(),
  782. parsePreprocessorDefs (getBuildConfigPreprocessorDefs().toString()));
  783. }
  784. const StringArray Project::BuildConfiguration::getHeaderSearchPaths() const
  785. {
  786. StringArray s;
  787. s.addTokens (getHeaderSearchPath().toString(), ";", String::empty);
  788. return s;
  789. }
  790. //==============================================================================
  791. ValueTree Project::getExporters()
  792. {
  793. ValueTree exporters (projectRoot.getChildWithName (Tags::exporters));
  794. if (! exporters.isValid())
  795. {
  796. projectRoot.addChild (ValueTree (Tags::exporters), 0, getUndoManagerFor (projectRoot));
  797. exporters = getExporters();
  798. }
  799. return exporters;
  800. }
  801. int Project::getNumExporters()
  802. {
  803. return getExporters().getNumChildren();
  804. }
  805. ProjectExporter* Project::createExporter (int index)
  806. {
  807. jassert (index >= 0 && index < getNumExporters());
  808. return ProjectExporter::createExporter (*this, getExporters().getChild (index));
  809. }
  810. void Project::addNewExporter (int exporterIndex)
  811. {
  812. ScopedPointer<ProjectExporter> exp (ProjectExporter::createNewExporter (*this, exporterIndex));
  813. ValueTree exporters (getExporters());
  814. exporters.addChild (exp->getSettings(), -1, getUndoManagerFor (exporters));
  815. }
  816. void Project::deleteExporter (int index)
  817. {
  818. ValueTree exporters (getExporters());
  819. exporters.removeChild (index, getUndoManagerFor (exporters));
  820. }
  821. void Project::createDefaultExporters()
  822. {
  823. ValueTree exporters (getExporters());
  824. exporters.removeAllChildren (getUndoManagerFor (exporters));
  825. for (int i = 0; i < ProjectExporter::getNumExporters(); ++i)
  826. addNewExporter (i);
  827. }
  828. //==============================================================================
  829. const String Project::getFileTemplate (const String& templateName)
  830. {
  831. int dataSize;
  832. const char* data = BinaryData::getNamedResource (templateName.toUTF8(), dataSize);
  833. if (data == 0)
  834. {
  835. jassertfalse;
  836. return String::empty;
  837. }
  838. return String::fromUTF8 (data, dataSize);
  839. }
  840. //==============================================================================
  841. void Project::resaveJucerFile (const File& file)
  842. {
  843. if (! file.exists())
  844. {
  845. std::cout << "The file " << file.getFullPathName() << " doesn't exist!" << std::endl;
  846. return;
  847. }
  848. if (! file.hasFileExtension (Project::projectFileExtension))
  849. {
  850. std::cout << file.getFullPathName() << " isn't a valid jucer project file!" << std::endl;
  851. return;
  852. }
  853. Project newDoc (file);
  854. if (! newDoc.loadFrom (file, true))
  855. {
  856. std::cout << "Failed to load the project file: " << file.getFullPathName() << std::endl;
  857. return;
  858. }
  859. std::cout << "The Jucer - Re-saving file: " << file.getFullPathName() << std::endl;
  860. String error (newDoc.saveDocument (file));
  861. if (error.isNotEmpty())
  862. {
  863. std::cout << "Error when writing project: " << error << std::endl;
  864. return;
  865. }
  866. }