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

311 lines
15KB
Raw Blame History 

  1. /*

  2.   ==============================================================================

  3. 

  4.    This file is part of the JUCE library - "Jules' Utility Class Extensions"

  5.    Copyright 2004-11 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 (Ids::bundleIdentifier); }

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

  81. 

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

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

  84. 

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

  86.     StringPairArray getPreprocessorDefs() const;

  87. 

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

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

  90.     Image getBigIcon();

  91.     Image getSmallIcon();

  92. 

  93.     //==============================================================================

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

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

  96. 

  97.     //==============================================================================

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

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

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

  101. 

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

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

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

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

  106. 

  107.     //==============================================================================

  108.     class Item

  109.     {

  110.     public:

  111.         //==============================================================================

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

  113.         Item (const Item& other);

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

  115.         ~Item();

  116. 

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

  118.         void initialiseNodeValues();

  119. 

  120.         //==============================================================================

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

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

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

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

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

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

  127. 

  128.         //==============================================================================

  129.         bool isFile() const;

  130.         bool isGroup() const;

  131.         bool isMainGroup() const;

  132.         bool isImageFile() const;

  133. 

  134.         String getID() const;

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

  136.         String getImageFileID() const;

  137.         void setID (const String& newID);

  138. 

  139.         //==============================================================================

  140.         Value getName() const;

  141.         File getFile() const;

  142.         String getFilePath() const;

  143.         void setFile (const File& file);

  144.         void setFile (const RelativePath& file);

  145.         File determineGroupFolder() const;

  146.         bool renameFile (const File& newFile);

  147. 

  148.         bool shouldBeAddedToTargetProject() const;

  149.         bool shouldBeCompiled() const;

  150.         Value getShouldCompileValue() const;

  151.         bool shouldBeAddedToBinaryResources() const;

  152.         Value getShouldAddToResourceValue() const;

  153.         Value getShouldInhibitWarningsValue() const;

  154.         Value getShouldUseStdCallValue() const;

  155. 

  156.         //==============================================================================

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

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

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

  160. 

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

  162.         Item getOrCreateSubGroup (const String& name);

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

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

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

  166.         void removeItemFromProject();

  167.         void sortAlphabetically (bool keepGroupsAtStart);

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

  169. 

  170.         Item getParent() const;

  171.         Item createCopy();

  172. 

  173.         const Drawable* getIcon() const;

  174. 

  175.     private:

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

  177.         Project* project;

  178.         ValueTree node;

  179. 

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

  181.     };

  182. 

  183.     Item getMainGroup();

  184. 

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

  186. 

  187.     //==============================================================================

  188.     class BuildConfiguration

  189.     {

  190.     public:

  191.         BuildConfiguration (const BuildConfiguration&);

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

  193.         ~BuildConfiguration();

  194. 

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

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

  197. 

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

  199. 

  200.         //==============================================================================

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

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

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

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

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

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

  207.         String getGCCOptimisationFlag() const;

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

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

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

  211.         StringArray getHeaderSearchPaths() const;

  212. 

  213.         static const char* const osxVersionDefault;

  214.         static const char* const osxVersion10_4;

  215.         static const char* const osxVersion10_5;

  216.         static const char* const osxVersion10_6;

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

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

  219. 

  220.         static const char* const osxArch_Default;

  221.         static const char* const osxArch_Native;

  222.         static const char* const osxArch_32BitUniversal;

  223.         static const char* const osxArch_64BitUniversal;

  224.         static const char* const osxArch_64Bit;

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

  226. 

  227.         //==============================================================================

  228.     private:

  229.         friend class Project;

  230.         Project* project;

  231.         ValueTree config;

  232. 

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

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

  235. 

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

  237.     };

  238. 

  239.     int getNumConfigurations() const;

  240.     BuildConfiguration getConfiguration (int index);

  241.     void addNewConfiguration (BuildConfiguration* configToCopy);

  242.     void deleteConfiguration (int index);

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

  244.     String getUniqueConfigName (String name) const;

  245. 

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

  247.     ValueTree getExporters();

  248.     int getNumExporters();

  249.     ProjectExporter* createExporter (int index);

  250.     void addNewExporter (const String& exporterName);

  251.     void deleteExporter (int index);

  252.     void createDefaultExporters();

  253. 

  254.     //==============================================================================

  255.     struct ConfigFlag

  256.     {

  257.         String symbol, description, sourceModuleID;

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

  259.     };

  260. 

  261.     static const char* const configFlagDefault;

  262.     static const char* const configFlagEnabled;

  263.     static const char* const configFlagDisabled;

  264.     Value getConfigFlag (const String& name);

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

  266. 

  267.     //==============================================================================

  268.     bool isModuleEnabled (const String& moduleID) const;

  269.     Value shouldShowAllModuleFilesInProject (const String& moduleID);

  270. 

  271.     void addModule (const String& moduleID);

  272.     void removeModule (const String& moduleID);

  273. 

  274.     //==============================================================================

  275.     String getFileTemplate (const String& templateName);

  276. 

  277.     //==============================================================================

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

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

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

  281.     void valueTreeChildOrderChanged (ValueTree& parentTree);

  282.     void valueTreeParentChanged (ValueTree& tree);

  283. 

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

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

  286. 

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

  288.     static const char* projectFileExtension;

  289. 

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

  291. 

  292. private:

  293.     friend class Item;

  294.     ValueTree projectRoot;

  295.     static File lastDocumentOpened;

  296.     DrawableImage mainProjectIcon;

  297. 

  298.     void updateProjectSettings();

  299.     void sanitiseConfigFlags();

  300.     void setMissingDefaultValues();

  301.     ValueTree getConfigurations() const;

  302.     void createDefaultConfigs();

  303.     ValueTree getConfigNode();

  304.     ValueTree getModulesNode();

  305. 

  306.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project);

  307. };

  308. 

  309. 

  310. #endif   // __JUCER_PROJECT_JUCEHEADER__