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.
1129 Commits
11 Branches
3.6GB
Tree: 9d00c15b67
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '9d00c15b67'
${ noResults }
JUCE/extras/Jucer (experimental)/Source/model/Project/jucer_Project.h

315 lines
16KB
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 (const 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 shouldBuildVST() const                        { return getProjectValue ("buildVST"); }

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

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

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

  109. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  125. 

  126.     //==============================================================================

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

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

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

  130. 

  131.     //==============================================================================

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

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

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

  135. 

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

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

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

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

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

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

  142. 

  143.     //==============================================================================

  144.     class Item

  145.     {

  146.     public:

  147.         //==============================================================================

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

  149.         Item (const Item& other);

  150.         ~Item();

  151. 

  152.         void initialiseNodeValues();

  153. 

  154.         //==============================================================================

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

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

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

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

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

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

  161. 

  162.         //==============================================================================

  163.         bool isFile() const;

  164.         bool isGroup() const;

  165.         bool isMainGroup() const;

  166. 

  167.         const String getID() const;

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

  169. 

  170.         //==============================================================================

  171.         Value getName() const;

  172.         const File getFile() const;

  173.         void setFile (const File& file);

  174.         const File determineGroupFolder() const;

  175.         bool renameFile (const File& newFile);

  176. 

  177.         bool shouldBeAddedToTargetProject() const;

  178.         bool shouldBeCompiled() const;

  179.         Value getShouldCompileValue() const;

  180.         bool shouldBeAddedToBinaryResources() const;

  181.         Value getShouldAddToResourceValue() const;

  182. 

  183.         //==============================================================================

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

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

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

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

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

  189.         void removeItemFromProject();

  190.         void sortAlphabetically();

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

  192. 

  193.         Item getParent() const;

  194. 

  195.         Image* getIcon() const;

  196. 

  197.     private:

  198.         //==============================================================================

  199.         Project& project;

  200.         ValueTree node;

  201. 

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

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

  204.     };

  205. 

  206.     Item getMainGroup();

  207.     Item createNewGroup();

  208.     Item createNewItem (const File& file);

  209. 

  210.     //==============================================================================

  211.     class BuildConfiguration

  212.     {

  213.     public:

  214.         BuildConfiguration (const BuildConfiguration&);

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

  216.         ~BuildConfiguration();

  217. 

  218.         //==============================================================================

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

  220. 

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

  222. 

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

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

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

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

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

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

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

  230.         const String getGCCOptimisationFlag() const;

  231.         Value getPreprocessorDefs() const                   { return getValue (Ids::defines); }

  232.         const StringArray parsePreprocessorDefs() const;

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

  234.         const StringArray getHeaderSearchPaths() const;

  235. 

  236.         static const char* const osxVersionDefault;

  237.         static const char* const osxVersion10_4;

  238.         static const char* const osxVersion10_5;

  239.         static const char* const osxVersion10_6;

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

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

  242. 

  243.         //==============================================================================

  244.     private:

  245.         friend class Project;

  246.         Project* project;

  247.         ValueTree config;

  248. 

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

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

  251. 

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

  253.     };

  254. 

  255.     int getNumConfigurations() const;

  256.     BuildConfiguration getConfiguration (int index);

  257.     void addNewConfiguration (BuildConfiguration* configToCopy);

  258.     void deleteConfiguration (int index);

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

  260.     const String getUniqueConfigName (String name) const;

  261. 

  262.     //==============================================================================

  263.     ValueTree getExporters();

  264.     int getNumExporters();

  265.     ProjectExporter* createExporter (int index);

  266.     void addNewExporter (int exporterIndex);

  267.     void deleteExporter (int index);

  268.     void createDefaultExporters();

  269. 

  270.     //==============================================================================

  271.     struct JuceConfigFlag

  272.     {

  273.         String symbol, description;

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

  275.     };

  276. 

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

  278. 

  279.     static const char* const configFlagDefault;

  280.     static const char* const configFlagEnabled;

  281.     static const char* const configFlagDisabled;

  282.     Value getJuceConfigFlag (const String& name);

  283. 

  284.     //==============================================================================

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

  286. 

  287.     //==============================================================================

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

  289.     void valueTreeChildrenChanged (ValueTree& tree);

  290.     void valueTreeParentChanged (ValueTree& tree);

  291. 

  292.     //==============================================================================

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

  294. 

  295.     //==============================================================================

  296.     static const char* projectFileExtension;

  297. 

  298. private:

  299.     ValueTree projectRoot;

  300.     static File lastDocumentOpened;

  301. 

  302.     const File getLocalJuceFolder();

  303.     void updateProjectSettings();

  304.     void setMissingDefaultValues();

  305.     ValueTree getConfigurations() const;

  306.     void createDefaultConfigs();

  307.     ValueTree getJuceConfigNode();

  308. 

  309.     Project (const Project&);

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

  311. };

  312. 

  313. 

  314. #endif   // __JUCER_PROJECT_JUCEHEADER__