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

330 lines
17KB
Raw Blame History 

  1. /*

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

  3. 

  4.    This file is part of the JUCE library - "Jules' Utility Class Extensions"

  5.    Copyright 2004-10 by Raw Material Software Ltd.

  6. 

  7.   ------------------------------------------------------------------------------

  8. 

  9.    JUCE can be redistributed and/or modified under the terms of the GNU General

  10.    Public License (Version 2), as published by the Free Software Foundation.

  11.    A copy of the license is included in the JUCE distribution, or can be found

  12.    online at www.gnu.org/licenses.

  13. 

  14.    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY

  15.    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR

  16.    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

  17. 

  18.   ------------------------------------------------------------------------------

  19. 

  20.    To release a closed-source product which uses JUCE, commercial licenses are

  21.    available: visit www.rawmaterialsoftware.com/juce for more information.

  22. 

  23.   ==============================================================================

  24. */

  25. 

  26. #ifndef __JUCER_PROJECT_JUCEHEADER__

  27. #define __JUCER_PROJECT_JUCEHEADER__

  28. 

  29. #include "../jucer_Headers.h"

  30. class ProjectExporter;

  31. 

  32. //==============================================================================

  33. class Project  : public FileBasedDocument,

  34.                  public ValueTree::Listener

  35. {

  36. public:

  37.     //==============================================================================

  38.     Project (const File& file);

  39.     ~Project();

  40. 

  41.     //==============================================================================

  42.     // FileBasedDocument stuff..

  43.     const String getDocumentTitle();

  44.     const String loadDocument (const File& file);

  45.     const String saveDocument (const File& file);

  46.     const File getLastDocumentOpened();

  47.     void setLastDocumentOpened (const File& file);

  48. 

  49.     void setTitle (const String& newTitle);

  50. 

  51.     //==============================================================================

  52.     ValueTree getProjectRoot() const                    { return projectRoot; }

  53.     Value getProjectName()                              { return getMainGroup().getName(); }

  54.     const String getProjectFilenameRoot()               { return File::createLegalFileName (getDocumentTitle()); }

  55.     const String getProjectUID() const                  { return projectRoot [Ids::id_]; }

  56. 

  57.     //==============================================================================

  58.     bool shouldBeAddedToBinaryResourcesByDefault (const File& file);

  59.     const File resolveFilename (String filename) const;

  60.     const String getRelativePathForFile (const File& file) const;

  61. 

  62.     //==============================================================================

  63.     // Creates editors for the project settings

  64.     void createPropertyEditors (Array <PropertyComponent*>& properties);

  65. 

  66.     //==============================================================================

  67.     // project types

  68.     static const char* const application;

  69.     static const char* const commandLineApp;

  70.     static const char* const audioPlugin;

  71.     static const char* const library;

  72.     static const char* const browserPlugin;

  73. 

  74.     Value getProjectType() const                        { return getProjectValue ("projectType"); }

  75. 

  76.     bool isLibrary() const;

  77.     bool isGUIApplication() const;

  78.     bool isCommandLineApp() const;

  79.     bool isAudioPlugin() const;

  80.     bool isBrowserPlugin() const;

  81. 

  82.     Value getVersion() const                            { return getProjectValue ("version"); }

  83.     Value getBundleIdentifier() const                   { return getProjectValue ("bundleIdentifier"); }

  84.     void setBundleIdentifierToDefault()                 { getBundleIdentifier() = "com.yourcompany." + CodeHelpers::makeValidIdentifier (getProjectName().toString(), false, true, false); }

  85. 

  86.     //==============================================================================

  87.     // linkage modes..

  88.     static const char* const notLinkedToJuce;

  89.     static const char* const useLinkedJuce;

  90.     static const char* const useAmalgamatedJuce;

  91.     static const char* const useAmalgamatedJuceViaSingleTemplate;

  92.     static const char* const useAmalgamatedJuceViaMultipleTemplates;

  93. 

  94.     Value getJuceLinkageModeValue() const               { return getProjectValue ("juceLinkage"); }

  95.     const String getJuceLinkageMode() const             { return getJuceLinkageModeValue().toString(); }

  96. 

  97.     bool isUsingWrapperFiles() const                    { return isUsingFullyAmalgamatedFile() || isUsingSingleTemplateFile() || isUsingMultipleTemplateFiles(); }

  98.     bool isUsingFullyAmalgamatedFile() const            { return getJuceLinkageMode() == useAmalgamatedJuce; }

  99.     bool isUsingSingleTemplateFile() const              { return getJuceLinkageMode() == useAmalgamatedJuceViaSingleTemplate; }

  100.     bool isUsingMultipleTemplateFiles() const           { return getJuceLinkageMode() == useAmalgamatedJuceViaMultipleTemplates; }

  101. 

  102.     //==============================================================================

  103.     Value getProjectValue (const Identifier& name) const       { return projectRoot.getPropertyAsValue (name, getUndoManagerFor (projectRoot)); }

  104. 

  105.     Value getProjectPreprocessorDefs() const            { return getProjectValue (Ids::defines); }

  106.     const StringPairArray getPreprocessorDefs() const;

  107. 

  108.     Value getBigIconImageItemID() const                 { return getProjectValue ("bigIcon"); }

  109.     Value getSmallIconImageItemID() const               { return getProjectValue ("smallIcon"); }

  110.     const Image getBigIcon();

  111.     const Image getSmallIcon();

  112. 

  113.     Value getObjectiveCClassSuffix() const              { return getProjectValue ("objCSuffix"); }

  114. 

  115.     Value shouldBuildVST() const                        { return getProjectValue ("buildVST"); }

  116.     Value shouldBuildRTAS() const                       { return getProjectValue ("buildRTAS"); }

  117.     Value shouldBuildAU() const                         { return getProjectValue ("buildAU"); }

  118.     bool shouldAddVSTFolderToPath()                     { return (isAudioPlugin() && (bool) shouldBuildVST().getValue()) || getJuceConfigFlag ("JUCE_PLUGINHOST_VST").toString() == configFlagEnabled; }

  119. 

  120.     Value getPluginName() const                         { return getProjectValue ("pluginName"); }

  121.     Value getPluginDesc() const                         { return getProjectValue ("pluginDesc"); }

  122.     Value getPluginManufacturer() const                 { return getProjectValue ("pluginManufacturer"); }

  123.     Value getPluginManufacturerCode() const             { return getProjectValue ("pluginManufacturerCode"); }

  124.     Value getPluginCode() const                         { return getProjectValue ("pluginCode"); }

  125.     Value getPluginChannelConfigs() const               { return getProjectValue ("pluginChannelConfigs"); }

  126.     Value getPluginIsSynth() const                      { return getProjectValue ("pluginIsSynth"); }

  127.     Value getPluginWantsMidiInput() const               { return getProjectValue ("pluginWantsMidiIn"); }

  128.     Value getPluginProducesMidiOut() const              { return getProjectValue ("pluginProducesMidiOut"); }

  129.     Value getPluginSilenceInProducesSilenceOut() const  { return getProjectValue ("pluginSilenceInIsSilenceOut"); }

  130.     Value getPluginTailLengthSeconds() const            { return getProjectValue ("pluginTailLength"); }

  131.     Value getPluginEditorNeedsKeyFocus() const          { return getProjectValue ("pluginEditorRequiresKeys"); }

  132.     Value getPluginAUExportPrefix() const               { return getProjectValue ("pluginAUExportPrefix"); }

  133.     Value getPluginAUCocoaViewClassName() const         { return getProjectValue ("pluginAUViewClass"); }

  134.     Value getPluginRTASCategory() const                 { return getProjectValue ("pluginRTASCategory"); }

  135. 

  136.     //==============================================================================

  137.     const File getAppIncludeFile() const                { return getWrapperFolder().getChildFile (getJuceSourceHFilename()); }

  138.     const File getWrapperFolder() const                 { return getFile().getSiblingFile ("JuceLibraryCode"); }

  139.     const File getPluginCharacteristicsFile() const     { return getWrapperFolder().getChildFile (getPluginCharacteristicsFilename()); }

  140. 

  141.     //==============================================================================

  142.     const String getAmalgamatedHeaderFileName() const       { return "juce_amalgamated.h"; }

  143.     const String getAmalgamatedMMFileName() const           { return "juce_amalgamated.mm"; }

  144.     const String getAmalgamatedCppFileName() const          { return "juce_amalgamated.cpp"; }

  145. 

  146.     const String getAppConfigFilename() const               { return "AppConfig.h"; }

  147.     const String getJuceSourceFilenameRoot() const          { return "JuceLibraryCode"; }

  148.     int getNumSeparateAmalgamatedFiles() const              { return 4; }

  149.     const String getJuceSourceHFilename() const             { return "JuceHeader.h"; }

  150.     const String getJuceCodeGroupName() const               { return "Juce Library Code"; }

  151.     const String getPluginCharacteristicsFilename() const   { return "JucePluginCharacteristics.h"; }

  152. 

  153.     //==============================================================================

  154.     class Item

  155.     {

  156.     public:

  157.         //==============================================================================

  158.         Item (Project& project, const ValueTree& itemNode);

  159.         Item (const Item& other);

  160.         ~Item();

  161. 

  162.         void initialiseNodeValues();

  163. 

  164.         //==============================================================================

  165.         bool isValid() const                            { return node.isValid(); }

  166.         const ValueTree& getNode() const throw()        { return node; }

  167.         ValueTree& getNode() throw()                    { return node; }

  168.         Project& getProject() const throw()             { return project; }

  169.         bool operator== (const Item& other) const       { return node == other.node && &project == &other.project; }

  170.         bool operator!= (const Item& other) const       { return ! operator== (other); }

  171. 

  172.         //==============================================================================

  173.         bool isFile() const;

  174.         bool isGroup() const;

  175.         bool isMainGroup() const;

  176. 

  177.         const String getID() const;

  178.         Item findItemWithID (const String& targetId) const; // (recursive search)

  179.         const String getImageFileID() const;

  180. 

  181.         //==============================================================================

  182.         Value getName() const;

  183.         const File getFile() const;

  184.         void setFile (const File& file);

  185.         const File determineGroupFolder() const;

  186.         bool renameFile (const File& newFile);

  187. 

  188.         bool shouldBeAddedToTargetProject() const;

  189.         bool shouldBeCompiled() const;

  190.         Value getShouldCompileValue() const;

  191.         bool shouldBeAddedToBinaryResources() const;

  192.         Value getShouldAddToResourceValue() const;

  193. 

  194.         //==============================================================================

  195.         bool canContain (const Item& child) const;

  196.         int getNumChildren() const                      { return node.getNumChildren(); }

  197.         Item getChild (int index) const                 { return Item (project, node.getChild (index)); }

  198.         void addChild (const Item& newChild, int insertIndex);

  199.         bool addFile (const File& file, int insertIndex);

  200.         void removeItemFromProject();

  201.         void sortAlphabetically();

  202.         Item findItemForFile (const File& file) const;

  203. 

  204.         Item getParent() const;

  205. 

  206.         const Image getIcon() const;

  207. 

  208.     private:

  209.         //==============================================================================

  210.         Project& project;

  211.         ValueTree node;

  212. 

  213.         UndoManager* getUndoManager() const              { return project.getUndoManagerFor (node); }

  214.         Item& operator= (const Item&);

  215.     };

  216. 

  217.     Item getMainGroup();

  218.     Item createNewGroup();

  219.     Item createNewItem (const File& file);

  220. 

  221.     void findAllImageItems (OwnedArray<Item>& items);

  222. 

  223.     //==============================================================================

  224.     class BuildConfiguration

  225.     {

  226.     public:

  227.         BuildConfiguration (const BuildConfiguration&);

  228.         const BuildConfiguration& operator= (const BuildConfiguration&);

  229.         ~BuildConfiguration();

  230. 

  231.         //==============================================================================

  232.         Project& getProject() const                         { return *project; }

  233. 

  234.         void createPropertyEditors (Array <PropertyComponent*>& properties);

  235. 

  236.         //==============================================================================

  237.         Value getName() const                               { return getValue (Ids::name); }

  238.         Value isDebug() const                               { return getValue (Ids::isDebug); }

  239.         Value getTargetBinaryName() const                   { return getValue (Ids::targetName); }

  240.         // the path relative to the build folder in which the binary should go

  241.         Value getTargetBinaryRelativePath() const           { return getValue (Ids::binaryPath); }

  242.         Value getOptimisationLevel() const                  { return getValue (Ids::optimisation); }

  243.         const String getGCCOptimisationFlag() const;

  244.         Value getBuildConfigPreprocessorDefs() const        { return getValue (Ids::defines); }

  245.         const StringPairArray getAllPreprocessorDefs() const; // includes inherited definitions

  246.         Value getHeaderSearchPath() const                   { return getValue (Ids::headerPath); }

  247.         const StringArray getHeaderSearchPaths() const;

  248. 

  249.         static const char* const osxVersionDefault;

  250.         static const char* const osxVersion10_4;

  251.         static const char* const osxVersion10_5;

  252.         static const char* const osxVersion10_6;

  253.         Value getMacSDKVersion() const                      { return getValue (Ids::osxSDK); }

  254.         Value getMacCompatibilityVersion() const            { return getValue (Ids::osxCompatibility); }

  255. 

  256.         //==============================================================================

  257.     private:

  258.         friend class Project;

  259.         Project* project;

  260.         ValueTree config;

  261. 

  262.         Value getValue (const Identifier& name) const       { return config.getPropertyAsValue (name, getUndoManager()); }

  263.         UndoManager* getUndoManager() const                 { return project->getUndoManagerFor (config); }

  264. 

  265.         BuildConfiguration (Project* project, const ValueTree& configNode);

  266.     };

  267. 

  268.     int getNumConfigurations() const;

  269.     BuildConfiguration getConfiguration (int index);

  270.     void addNewConfiguration (BuildConfiguration* configToCopy);

  271.     void deleteConfiguration (int index);

  272.     bool hasConfigurationNamed (const String& name) const;

  273.     const String getUniqueConfigName (String name) const;

  274. 

  275.     //==============================================================================

  276.     ValueTree getExporters();

  277.     int getNumExporters();

  278.     ProjectExporter* createExporter (int index);

  279.     void addNewExporter (int exporterIndex);

  280.     void deleteExporter (int index);

  281.     void createDefaultExporters();

  282. 

  283.     //==============================================================================

  284.     struct JuceConfigFlag

  285.     {

  286.         String symbol, description;

  287.         Value value;   // 1 = true, 2 = false, anything else = use default

  288.     };

  289. 

  290.     void getJuceConfigFlags (OwnedArray <JuceConfigFlag>& flags);

  291. 

  292.     static const char* const configFlagDefault;

  293.     static const char* const configFlagEnabled;

  294.     static const char* const configFlagDisabled;

  295.     Value getJuceConfigFlag (const String& name);

  296. 

  297.     //==============================================================================

  298.     const String getFileTemplate (const String& templateName);

  299. 

  300.     //==============================================================================

  301.     void valueTreePropertyChanged (ValueTree& tree, const Identifier& property);

  302.     void valueTreeChildrenChanged (ValueTree& tree);

  303.     void valueTreeParentChanged (ValueTree& tree);

  304. 

  305.     //==============================================================================

  306.     UndoManager* getUndoManagerFor (const ValueTree& node) const             { return 0; }

  307. 

  308.     //==============================================================================

  309.     static const char* projectFileExtension;

  310. 

  311.     static void resaveJucerFile (const File& file);

  312. 

  313. private:

  314.     ValueTree projectRoot;

  315.     static File lastDocumentOpened;

  316. 

  317.     const File getLocalJuceFolder();

  318.     void updateProjectSettings();

  319.     void setMissingDefaultValues();

  320.     ValueTree getConfigurations() const;

  321.     void createDefaultConfigs();

  322.     ValueTree getJuceConfigNode();

  323. 

  324.     Project (const Project&);

  325.     const Project& operator= (const Project&);

  326. };

  327. 

  328. 

  329. #endif   // __JUCER_PROJECT_JUCEHEADER__