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.
1107 Commits
9 Branches
428MB
Tree: 87e416a278
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '87e416a278'
${ noResults }
JUCE/extras/Jucer (experimental)/Source/model/Project/jucer_Project.h

311 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 ["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 type info

  68.     enum ProjectType

  69.     {

  70.         application     = 1, // must all be sequntial, starting from 1, so that combo boxes can update correctly

  71.         commandLineApp  = 2,

  72.         audioPlugin     = 3,

  73.         library         = 4,

  74.         browserPlugin   = 5

  75.     };

  76. 

  77.     const StringArray getProjectTypes() const;

  78.     Value getProjectType() const;

  79. 

  80.     bool isLibrary() const                              { return (int) getProjectType().getValue() == (int) library; }

  81.     bool isGUIApplication() const                       { return (int) getProjectType().getValue() == (int) application; }

  82.     bool isCommandLineApp() const                       { return (int) getProjectType().getValue() == (int) commandLineApp; }

  83.     bool isAudioPlugin() const                          { return (int) getProjectType().getValue() == (int) audioPlugin; }

  84.     bool isBrowserPlugin() const                        { return (int) getProjectType().getValue() == (int) browserPlugin; }

  85. 

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

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

  88.     void setBundleIdentifierToDefault()                 { getBundleIdentifier() = "com.yourcompany." + makeValidCppIdentifier (getProjectName().toString(), false, true, false); }

  89. 

  90.     //==============================================================================

  91.     enum JuceLinkage

  92.     {

  93.         notLinkedToJuce = 1,   // must all be sequntial, starting from 1, so that combo boxes can update correctly

  94.         useLinkedJuce = 2,

  95.         useAmalgamatedJuce = 3,

  96.         useAmalgamatedJuceViaSingleTemplate = 4,

  97.         useAmalgamatedJuceViaMultipleTemplates = 5,

  98.     };

  99. 

  100.     const StringArray getJuceLinkageModes() const;

  101.     Value getJuceLinkageModeValue() const;

  102.     JuceLinkage getJuceLinkageMode() const              { return (JuceLinkage) (int) getJuceLinkageModeValue().getValue(); }

  103. 

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

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

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

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

  108. 

  109.     //==============================================================================

  110.     Value getProjectValue (const var::identifier& name) const       { return projectRoot.getPropertyAsValue (name, getUndoManagerFor (projectRoot)); }

  111. 

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

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

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

  115.     bool shouldAddVSTFolderToPath()                     { return (isAudioPlugin() && (bool) shouldBuildVST().getValue()) || (int) getJuceConfigFlag ("JUCE_PLUGINHOST_VST").getValue() == 1; }

  116. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  132. 

  133.     //==============================================================================

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

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

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

  137. 

  138.     //==============================================================================

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

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

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

  142. 

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

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

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

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

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

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

  149. 

  150.     //==============================================================================

  151.     class Item

  152.     {

  153.     public:

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

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

  156.         Item (const Item& other);

  157.         ~Item();

  158. 

  159.         void initialiseNodeValues();

  160. 

  161.         //==============================================================================

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

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

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

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

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

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

  168. 

  169.         //==============================================================================

  170.         bool isFile() const;

  171.         bool isGroup() const;

  172.         bool isMainGroup() const;

  173. 

  174.         const String getID() const;

  175. 

  176.         //==============================================================================

  177.         Value getName() const;

  178.         const File getFile() const;

  179.         void setFile (const File& file);

  180.         const File determineGroupFolder() const;

  181.         bool renameFile (const File& newFile);

  182. 

  183.         bool shouldBeAddedToTargetProject() const;

  184.         bool shouldBeCompiled() const;

  185.         Value getShouldCompileValue() const;

  186.         bool shouldBeAddedToBinaryResources() const;

  187.         Value getShouldAddToResourceValue() const;

  188. 

  189.         //==============================================================================

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

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

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

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

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

  195.         void removeItemFromProject();

  196.         void sortAlphabetically();

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

  198. 

  199.         Item getParent() const;

  200. 

  201.         Image* getIcon() const;

  202. 

  203.     private:

  204.         //==============================================================================

  205.         Project& project;

  206.         ValueTree node;

  207. 

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

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

  210.     };

  211. 

  212.     Item getMainGroup();

  213.     Item createNewGroup();

  214.     Item createNewItem (const File& file);

  215. 

  216.     //==============================================================================

  217.     class BuildConfiguration

  218.     {

  219.     public:

  220.         BuildConfiguration (const BuildConfiguration&);

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

  222.         ~BuildConfiguration();

  223. 

  224.         //==============================================================================

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

  226. 

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

  228. 

  229.         //==============================================================================

  230.         Value getName() const                               { return config.getPropertyAsValue ("name", getUndoManager()); }

  231.         Value isDebug() const                               { return config.getPropertyAsValue ("isDebug", getUndoManager()); }

  232.         Value getTargetBinaryName() const                   { return config.getPropertyAsValue ("targetName", getUndoManager()); }

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

  234.         Value getTargetBinaryRelativePath() const           { return config.getPropertyAsValue ("binaryPath", getUndoManager()); }

  235.         Value getOptimisationLevel() const                  { return config.getPropertyAsValue ("optimisation", getUndoManager()); }

  236.         const String getGCCOptimisationFlag() const;

  237.         Value getPreprocessorDefs() const                   { return config.getPropertyAsValue ("defines", getUndoManager()); }

  238.         const StringArray parsePreprocessorDefs() const;

  239.         Value getHeaderSearchPath() const                   { return config.getPropertyAsValue ("headerPath", getUndoManager()); }

  240.         const StringArray getHeaderSearchPaths() const;

  241.         Value getMacSDKVersion() const;

  242.         Value getMacCompatibilityVersion() const;

  243. 

  244.         //==============================================================================

  245.     private:

  246.         friend class Project;

  247.         Project* project;

  248.         ValueTree config;

  249. 

  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.     Value getJuceConfigFlag (const String& name);

  279. 

  280.     //==============================================================================

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

  282. 

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

  284.     void valueTreePropertyChanged (ValueTree& tree, const var::identifier& property);

  285.     void valueTreeChildrenChanged (ValueTree& tree);

  286.     void valueTreeParentChanged (ValueTree& tree);

  287. 

  288.     //==============================================================================

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

  290. 

  291.     //==============================================================================

  292.     static const char* projectFileExtension;

  293. 

  294. private:

  295.     ValueTree projectRoot;

  296.     static File lastDocumentOpened;

  297. 

  298.     const File getLocalJuceFolder();

  299.     void updateProjectSettings();

  300.     void setMissingDefaultValues();

  301.     ValueTree getConfigurations() const;

  302.     void createDefaultConfigs();

  303.     ValueTree getJuceConfigNode();

  304. 

  305.     Project (const Project&);

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

  307. };

  308. 

  309. 

  310. #endif   // __JUCER_PROJECT_JUCEHEADER__