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.
1528 Commits
9 Branches
13GB
Tree: e627847d32
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e627847d32'
${ noResults }
JUCE/extras/Introjucer/Source/Project/jucer_Project.h

342 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.     template <class FileType>

  60.     bool shouldBeAddedToBinaryResourcesByDefault (const FileType& file)

  61.     {

  62.         return ! file.hasFileExtension (sourceOrHeaderFileExtensions);

  63.     }

  64. 

  65.     File resolveFilename (String filename) const;

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

  67. 

  68.     //==============================================================================

  69.     // Creates editors for the project settings

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

  71. 

  72.     //==============================================================================

  73.     // project types

  74.     const ProjectType& getProjectType() const;

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

  76. 

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

  78.     String getVersionAsHex() const;

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

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

  81. 

  82.     //==============================================================================

  83.     // linkage modes..

  84.     static const char* const notLinkedToJuce;

  85.     static const char* const useLinkedJuce;

  86.     static const char* const useAmalgamatedJuce;

  87.     static const char* const useAmalgamatedJuceViaSingleTemplate;

  88.     static const char* const useAmalgamatedJuceViaMultipleTemplates;

  89. 

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

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

  92. 

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

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

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

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

  97. 

  98.     //==============================================================================

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

  100. 

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

  102.     StringPairArray getPreprocessorDefs() const;

  103. 

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

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

  106.     Image getBigIcon();

  107.     Image getSmallIcon();

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

  109. 

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

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

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

  113. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  129. 

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

  131.     File getAppIncludeFile() const                      { return getGeneratedCodeFolder().getChildFile (getJuceSourceHFilename()); }

  132.     File getGeneratedCodeFolder() const                 { return getFile().getSiblingFile ("JuceLibraryCode"); }

  133.     File getPluginCharacteristicsFile() const           { return getGeneratedCodeFolder().getChildFile (getPluginCharacteristicsFilename()); }

  134.     File getLocalJuceFolder();

  135. 

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

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

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

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

  140. 

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

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

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

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

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

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

  147. 

  148.     //==============================================================================

  149.     class Item

  150.     {

  151.     public:

  152.         //==============================================================================

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

  154.         Item (const Item& other);

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

  156.         ~Item();

  157. 

  158.         static Item createGroup (Project& project, const String& name);

  159.         void initialiseNodeValues();

  160. 

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

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

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

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

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

  174. 

  175.         String getID() const;

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

  177.         String getImageFileID() const;

  178.         void setID (const String& newID);

  179. 

  180.         //==============================================================================

  181.         Value getName() const;

  182.         File getFile() const;

  183.         String getFilePath() const;

  184.         void setFile (const File& file);

  185.         void setFile (const RelativePath& file);

  186.         File determineGroupFolder() const;

  187.         bool renameFile (const File& newFile);

  188. 

  189.         bool shouldBeAddedToTargetProject() const;

  190.         bool shouldBeCompiled() const;

  191.         Value getShouldCompileValue() const;

  192.         bool shouldBeAddedToBinaryResources() const;

  193.         Value getShouldAddToResourceValue() const;

  194.         Value getShouldInhibitWarningsValue() const;

  195. 

  196.         //==============================================================================

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

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

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

  200. 

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

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

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

  204.         bool addRelativeFile (const RelativePath& file, int insertIndex, bool shouldCompile);

  205.         void removeItemFromProject();

  206.         void sortAlphabetically();

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

  208. 

  209.         Item getParent() const;

  210. 

  211.         const Drawable* getIcon() const;

  212. 

  213.     private:

  214.         //==============================================================================

  215.         Project* project;

  216.         ValueTree node;

  217. 

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

  219.     };

  220. 

  221.     Item getMainGroup();

  222. 

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

  224. 

  225.     //==============================================================================

  226.     class BuildConfiguration

  227.     {

  228.     public:

  229.         BuildConfiguration (const BuildConfiguration&);

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

  231.         ~BuildConfiguration();

  232. 

  233.         //==============================================================================

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

  235. 

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

  237. 

  238.         //==============================================================================

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

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

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

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

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

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

  245.         String getGCCOptimisationFlag() const;

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

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

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

  249.         StringArray getHeaderSearchPaths() const;

  250. 

  251.         static const char* const osxVersionDefault;

  252.         static const char* const osxVersion10_4;

  253.         static const char* const osxVersion10_5;

  254.         static const char* const osxVersion10_6;

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

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

  257. 

  258.         static const char* const osxArch_Default;

  259.         static const char* const osxArch_Native;

  260.         static const char* const osxArch_32BitUniversal;

  261.         static const char* const osxArch_64BitUniversal;

  262.         static const char* const osxArch_64Bit;

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

  264. 

  265.         //==============================================================================

  266.     private:

  267.         friend class Project;

  268.         Project* project;

  269.         ValueTree config;

  270. 

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

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

  273. 

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

  275.     };

  276. 

  277.     int getNumConfigurations() const;

  278.     BuildConfiguration getConfiguration (int index);

  279.     void addNewConfiguration (BuildConfiguration* configToCopy);

  280.     void deleteConfiguration (int index);

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

  282.     String getUniqueConfigName (String name) const;

  283. 

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

  285.     ValueTree getExporters();

  286.     int getNumExporters();

  287.     ProjectExporter* createExporter (int index);

  288.     void addNewExporter (int exporterIndex);

  289.     void deleteExporter (int index);

  290.     void createDefaultExporters();

  291. 

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

  293.     struct ConfigFlag

  294.     {

  295.         String symbol, description;

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

  297.     };

  298. 

  299.     void getAllConfigFlags (OwnedArray <ConfigFlag>& flags);

  300. 

  301.     static const char* const configFlagDefault;

  302.     static const char* const configFlagEnabled;

  303.     static const char* const configFlagDisabled;

  304.     Value getConfigFlag (const String& name);

  305.     bool isConfigFlagEnabled (const String& name) const;

  306. 

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

  308.     String getFileTemplate (const String& templateName);

  309. 

  310.     //==============================================================================

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

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

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

  314.     void valueTreeChildOrderChanged (ValueTree& parentTree);

  315.     void valueTreeParentChanged (ValueTree& tree);

  316. 

  317.     //==============================================================================

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

  319. 

  320.     //==============================================================================

  321.     static const char* projectFileExtension;

  322. 

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

  324. 

  325. private:

  326.     friend class Item;

  327.     ValueTree projectRoot;

  328.     static File lastDocumentOpened;

  329.     DrawableImage mainProjectIcon;

  330. 

  331.     void updateProjectSettings();

  332.     void setMissingDefaultValues();

  333.     ValueTree getConfigurations() const;

  334.     void createDefaultConfigs();

  335.     ValueTree getConfigNode();

  336. 

  337.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project);

  338. };

  339. 

  340. 

  341. #endif   // __JUCER_PROJECT_JUCEHEADER__