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.
1525 Commits
11 Branches
450MB
Tree: 2dff4cd3fa
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2dff4cd3fa'
${ noResults }
JUCE/extras/Introjucer/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. class ProjectType;

  32. 

  33. //==============================================================================

  34. class Project  : public FileBasedDocument,

  35.                  public ValueTree::Listener

  36. {

  37. public:

  38.     //==============================================================================

  39.     Project (const File& file);

  40.     ~Project();

  41. 

  42.     //==============================================================================

  43.     // FileBasedDocument stuff..

  44.     const String getDocumentTitle();

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

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

  47.     const File getLastDocumentOpened();

  48.     void setLastDocumentOpened (const File& file);

  49. 

  50.     void setTitle (const String& newTitle);

  51. 

  52.     //==============================================================================

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

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

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

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

  57. 

  58.     //==============================================================================

  59.     bool shouldBeAddedToBinaryResourcesByDefault (const File& file);

  60.     File resolveFilename (String filename) const;

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

  62. 

  63.     //==============================================================================

  64.     // Creates editors for the project settings

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

  66. 

  67.     //==============================================================================

  68.     // project types

  69.     const ProjectType& getProjectType() const;

  70.     Value getProjectTypeValue() const                   { return getProjectValue ("projectType"); }

  71. 

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

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

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

  75. 

  76.     //==============================================================================

  77.     // linkage modes..

  78.     static const char* const notLinkedToJuce;

  79.     static const char* const useLinkedJuce;

  80.     static const char* const useAmalgamatedJuce;

  81.     static const char* const useAmalgamatedJuceViaSingleTemplate;

  82.     static const char* const useAmalgamatedJuceViaMultipleTemplates;

  83. 

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

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

  86. 

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

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

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

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

  91. 

  92.     //==============================================================================

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

  94. 

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

  96.     StringPairArray getPreprocessorDefs() const;

  97. 

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

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

  100.     Image getBigIcon();

  101.     Image getSmallIcon();

  102.     Image getBestIconForSize (int size, bool returnNullIfNothingBigEnough);

  103. 

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

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

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

  107.     bool shouldAddVSTFolderToPath();

  108. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  124. 

  125.     //==============================================================================

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

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

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

  129. 

  130.     //==============================================================================

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

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

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

  134. 

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

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

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

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

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

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

  141. 

  142.     //==============================================================================

  143.     class Item

  144.     {

  145.     public:

  146.         //==============================================================================

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

  148.         Item (const Item& other);

  149.         Item& operator= (const Item& other);

  150.         ~Item();

  151. 

  152.         void initialiseNodeValues();

  153. 

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

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

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

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

  158.         Project& getProject() const noexcept            { 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.         bool isImageFile() const;

  167. 

  168.         String getID() const;

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

  170.         String getImageFileID() const;

  171. 

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

  173.         Value getName() const;

  174.         File getFile() const;

  175.         void setFile (const File& file);

  176.         File determineGroupFolder() const;

  177.         bool renameFile (const File& newFile);

  178. 

  179.         bool shouldBeAddedToTargetProject() const;

  180.         bool shouldBeCompiled() const;

  181.         Value getShouldCompileValue() const;

  182.         bool shouldBeAddedToBinaryResources() const;

  183.         Value getShouldAddToResourceValue() const;

  184. 

  185.         //==============================================================================

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

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

  188.         Item getChild (int index) const                 { return Item (getProject(), node.getChild (index)); }

  189. 

  190.         Item addNewSubGroup (const String& name, int insertIndex);

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

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

  193.         void removeItemFromProject();

  194.         void sortAlphabetically();

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

  196. 

  197.         Item getParent() const;

  198. 

  199.         const Drawable* getIcon() const;

  200. 

  201.     private:

  202.         //==============================================================================

  203.         Project* project;

  204.         ValueTree node;

  205. 

  206.         UndoManager* getUndoManager() const              { return getProject().getUndoManagerFor (node); }

  207.     };

  208. 

  209.     Item getMainGroup();

  210. 

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

  212. 

  213.     //==============================================================================

  214.     class BuildConfiguration

  215.     {

  216.     public:

  217.         BuildConfiguration (const BuildConfiguration&);

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

  219.         ~BuildConfiguration();

  220. 

  221.         //==============================================================================

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

  223. 

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

  225. 

  226.         //==============================================================================

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

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

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

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

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

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

  233.         String getGCCOptimisationFlag() const;

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

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

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

  237.         StringArray getHeaderSearchPaths() const;

  238. 

  239.         static const char* const osxVersionDefault;

  240.         static const char* const osxVersion10_4;

  241.         static const char* const osxVersion10_5;

  242.         static const char* const osxVersion10_6;

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

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

  245. 

  246.         static const char* const osxArch_Default;

  247.         static const char* const osxArch_Native;

  248.         static const char* const osxArch_32BitUniversal;

  249.         static const char* const osxArch_64BitUniversal;

  250.         static const char* const osxArch_64Bit;

  251.         Value getMacArchitecture() const                    { return getValue (Ids::osxArchitecture); }

  252. 

  253.         //==============================================================================

  254.     private:

  255.         friend class Project;

  256.         Project* project;

  257.         ValueTree config;

  258. 

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

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

  261. 

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

  263.     };

  264. 

  265.     int getNumConfigurations() const;

  266.     BuildConfiguration getConfiguration (int index);

  267.     void addNewConfiguration (BuildConfiguration* configToCopy);

  268.     void deleteConfiguration (int index);

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

  270.     String getUniqueConfigName (String name) const;

  271. 

  272.     //==============================================================================

  273.     ValueTree getExporters();

  274.     int getNumExporters();

  275.     ProjectExporter* createExporter (int index);

  276.     void addNewExporter (int exporterIndex);

  277.     void deleteExporter (int index);

  278.     void createDefaultExporters();

  279. 

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

  281.     struct JuceConfigFlag

  282.     {

  283.         String symbol, description;

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

  285.     };

  286. 

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

  288. 

  289.     static const char* const configFlagDefault;

  290.     static const char* const configFlagEnabled;

  291.     static const char* const configFlagDisabled;

  292.     Value getJuceConfigFlag (const String& name);

  293. 

  294.     //==============================================================================

  295.     String getFileTemplate (const String& templateName);

  296. 

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

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

  299.     void valueTreeChildAdded (ValueTree& parentTree, ValueTree& childWhichHasBeenAdded);

  300.     void valueTreeChildRemoved (ValueTree& parentTree, ValueTree& childWhichHasBeenRemoved);

  301.     void valueTreeChildOrderChanged (ValueTree& parentTree);

  302.     void valueTreeParentChanged (ValueTree& tree);

  303. 

  304.     //==============================================================================

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

  306. 

  307.     //==============================================================================

  308.     static const char* projectFileExtension;

  309. 

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

  311. 

  312. private:

  313.     friend class Item;

  314.     ValueTree projectRoot;

  315.     static File lastDocumentOpened;

  316.     DrawableImage mainProjectIcon;

  317. 

  318.     File getLocalJuceFolder();

  319.     void updateProjectSettings();

  320.     void setMissingDefaultValues();

  321.     ValueTree getConfigurations() const;

  322.     void createDefaultConfigs();

  323.     ValueTree getJuceConfigNode();

  324. 

  325.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project);

  326. };

  327. 

  328. 

  329. #endif   // __JUCER_PROJECT_JUCEHEADER__