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.
1545 Commits
9 Branches
625MB
Tree: 1a21c89755
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1a21c89755'
${ noResults }
JUCE/extras/Introjucer/Source/Project/jucer_Project.h

323 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. 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. 

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

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

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

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

  113.     File getLocalJuceFolder();

  114. 

  115.     //==============================================================================

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

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

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

  119. 

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

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

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

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

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

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

  126. 

  127.     //==============================================================================

  128.     class Item

  129.     {

  130.     public:

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

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

  133.         Item (const Item& other);

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

  135.         ~Item();

  136. 

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

  138.         void initialiseNodeValues();

  139. 

  140.         //==============================================================================

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

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

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

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

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

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

  147. 

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

  149.         bool isFile() const;

  150.         bool isGroup() const;

  151.         bool isMainGroup() const;

  152.         bool isImageFile() const;

  153. 

  154.         String getID() const;

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

  156.         String getImageFileID() const;

  157.         void setID (const String& newID);

  158. 

  159.         //==============================================================================

  160.         Value getName() const;

  161.         File getFile() const;

  162.         String getFilePath() const;

  163.         void setFile (const File& file);

  164.         void setFile (const RelativePath& file);

  165.         File determineGroupFolder() const;

  166.         bool renameFile (const File& newFile);

  167. 

  168.         bool shouldBeAddedToTargetProject() const;

  169.         bool shouldBeCompiled() const;

  170.         Value getShouldCompileValue() const;

  171.         bool shouldBeAddedToBinaryResources() const;

  172.         Value getShouldAddToResourceValue() const;

  173.         Value getShouldInhibitWarningsValue() const;

  174.         Value getShouldUseStdCallValue() const;

  175. 

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

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

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

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

  180. 

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

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

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

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

  185.         void removeItemFromProject();

  186.         void sortAlphabetically();

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

  188. 

  189.         Item getParent() const;

  190.         Item createCopy();

  191. 

  192.         const Drawable* getIcon() const;

  193. 

  194.     private:

  195.         //==============================================================================

  196.         Project* project;

  197.         ValueTree node;

  198. 

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

  200.     };

  201. 

  202.     Item getMainGroup();

  203. 

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

  205. 

  206.     //==============================================================================

  207.     class BuildConfiguration

  208.     {

  209.     public:

  210.         BuildConfiguration (const BuildConfiguration&);

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

  212.         ~BuildConfiguration();

  213. 

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

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

  216. 

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

  218. 

  219.         //==============================================================================

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

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

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

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

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

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

  226.         String getGCCOptimisationFlag() const;

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

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

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

  230.         StringArray getHeaderSearchPaths() const;

  231. 

  232.         static const char* const osxVersionDefault;

  233.         static const char* const osxVersion10_4;

  234.         static const char* const osxVersion10_5;

  235.         static const char* const osxVersion10_6;

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

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

  238. 

  239.         static const char* const osxArch_Default;

  240.         static const char* const osxArch_Native;

  241.         static const char* const osxArch_32BitUniversal;

  242.         static const char* const osxArch_64BitUniversal;

  243.         static const char* const osxArch_64Bit;

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

  245. 

  246.         //==============================================================================

  247.     private:

  248.         friend class Project;

  249.         Project* project;

  250.         ValueTree config;

  251. 

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

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

  254. 

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

  256.     };

  257. 

  258.     int getNumConfigurations() const;

  259.     BuildConfiguration getConfiguration (int index);

  260.     void addNewConfiguration (BuildConfiguration* configToCopy);

  261.     void deleteConfiguration (int index);

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

  263.     String getUniqueConfigName (String name) const;

  264. 

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

  266.     ValueTree getExporters();

  267.     int getNumExporters();

  268.     ProjectExporter* createExporter (int index);

  269.     void addNewExporter (int exporterIndex);

  270.     void deleteExporter (int index);

  271.     void createDefaultExporters();

  272. 

  273.     //==============================================================================

  274.     struct ConfigFlag

  275.     {

  276.         String symbol, description;

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

  278.     };

  279. 

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

  281. 

  282.     static const char* const configFlagDefault;

  283.     static const char* const configFlagEnabled;

  284.     static const char* const configFlagDisabled;

  285.     Value getConfigFlag (const String& name);

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

  287. 

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

  289.     String getFileTemplate (const String& templateName);

  290. 

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

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

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

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

  295.     void valueTreeChildOrderChanged (ValueTree& parentTree);

  296.     void valueTreeParentChanged (ValueTree& tree);

  297. 

  298.     //==============================================================================

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

  300. 

  301.     //==============================================================================

  302.     static const char* projectFileExtension;

  303. 

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

  305. 

  306. private:

  307.     friend class Item;

  308.     ValueTree projectRoot;

  309.     static File lastDocumentOpened;

  310.     DrawableImage mainProjectIcon;

  311. 

  312.     void updateProjectSettings();

  313.     void setMissingDefaultValues();

  314.     ValueTree getConfigurations() const;

  315.     void createDefaultConfigs();

  316.     ValueTree getConfigNode();

  317. 

  318.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project);

  319. };

  320. 

  321. 

  322. #endif   // __JUCER_PROJECT_JUCEHEADER__