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

316 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. class ModuleList;

  33. class LibraryModule;

  34. 

  35. //==============================================================================

  36. class Project  : public FileBasedDocument,

  37.                  public ValueTree::Listener

  38. {

  39. public:

  40.     //==============================================================================

  41.     Project (const File& file);

  42.     ~Project();

  43. 

  44.     //==============================================================================

  45.     // FileBasedDocument stuff..

  46.     const String getDocumentTitle();

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

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

  49.     const File getLastDocumentOpened();

  50.     void setLastDocumentOpened (const File& file);

  51. 

  52.     void setTitle (const String& newTitle);

  53. 

  54.     //==============================================================================

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

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

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

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

  59. 

  60.     //==============================================================================

  61.     template <class FileType>

  62.     bool shouldBeAddedToBinaryResourcesByDefault (const FileType& file)

  63.     {

  64.         return ! file.hasFileExtension (sourceOrHeaderFileExtensions);

  65.     }

  66. 

  67.     File resolveFilename (String filename) const;

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

  69. 

  70.     //==============================================================================

  71.     // Creates editors for the project settings

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

  73. 

  74.     //==============================================================================

  75.     // project types

  76.     const ProjectType& getProjectType() const;

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

  78. 

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

  80.     String getVersionAsHex() const;

  81.     Value getBundleIdentifier() const                   { return getProjectValue (Ids::bundleIdentifier); }

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

  83. 

  84.     //==============================================================================

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

  86. 

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

  88.     StringPairArray getPreprocessorDefs() const;

  89. 

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

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

  92.     Image getBigIcon();

  93.     Image getSmallIcon();

  94. 

  95.     //==============================================================================

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

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

  98. 

  99.     //==============================================================================

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

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

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

  103. 

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

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

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

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

  108. 

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

  110.     class Item

  111.     {

  112.     public:

  113.         //==============================================================================

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

  115.         Item (const Item& other);

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

  117.         ~Item();

  118. 

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

  120.         void initialiseNodeValues();

  121. 

  122.         //==============================================================================

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

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

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

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

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

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

  129. 

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

  131.         bool isFile() const;

  132.         bool isGroup() const;

  133.         bool isMainGroup() const;

  134.         bool isImageFile() const;

  135. 

  136.         String getID() const;

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

  138.         String getImageFileID() const;

  139.         void setID (const String& newID);

  140. 

  141.         //==============================================================================

  142.         Value getName() const;

  143.         File getFile() const;

  144.         String getFilePath() const;

  145.         void setFile (const File& file);

  146.         void setFile (const RelativePath& file);

  147.         File determineGroupFolder() const;

  148.         bool renameFile (const File& newFile);

  149. 

  150.         bool shouldBeAddedToTargetProject() const;

  151.         bool shouldBeCompiled() const;

  152.         Value getShouldCompileValue() const;

  153.         bool shouldBeAddedToBinaryResources() const;

  154.         Value getShouldAddToResourceValue() const;

  155.         Value getShouldInhibitWarningsValue() const;

  156.         Value getShouldUseStdCallValue() const;

  157. 

  158.         //==============================================================================

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

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

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

  162. 

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

  164.         Item getOrCreateSubGroup (const String& name);

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

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

  167.         void addFileUnchecked (const File& file, int insertIndex, bool shouldCompile);

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

  169.         void removeItemFromProject();

  170.         void sortAlphabetically (bool keepGroupsAtStart);

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

  172.         bool containsChildForFile (const RelativePath& file) const;

  173. 

  174.         Item getParent() const;

  175.         Item createCopy();

  176. 

  177.         const Drawable* getIcon() const;

  178. 

  179.     private:

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

  181.         Project* project;

  182.         ValueTree node;

  183. 

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

  185.     };

  186. 

  187.     Item getMainGroup();

  188. 

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

  190. 

  191.     //==============================================================================

  192.     class BuildConfiguration

  193.     {

  194.     public:

  195.         BuildConfiguration (const BuildConfiguration&);

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

  197.         ~BuildConfiguration();

  198. 

  199.         //==============================================================================

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

  201. 

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

  203. 

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

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

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

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

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

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

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

  211.         String getGCCOptimisationFlag() const;

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

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

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

  215.         StringArray getHeaderSearchPaths() const;

  216. 

  217.         static const char* const osxVersionDefault;

  218.         static const char* const osxVersion10_4;

  219.         static const char* const osxVersion10_5;

  220.         static const char* const osxVersion10_6;

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

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

  223. 

  224.         static const char* const osxArch_Default;

  225.         static const char* const osxArch_Native;

  226.         static const char* const osxArch_32BitUniversal;

  227.         static const char* const osxArch_64BitUniversal;

  228.         static const char* const osxArch_64Bit;

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

  230. 

  231.         //==============================================================================

  232.     private:

  233.         friend class Project;

  234.         Project* project;

  235.         ValueTree config;

  236. 

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

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

  239. 

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

  241.     };

  242. 

  243.     int getNumConfigurations() const;

  244.     BuildConfiguration getConfiguration (int index);

  245.     void addNewConfiguration (BuildConfiguration* configToCopy);

  246.     void deleteConfiguration (int index);

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

  248.     String getUniqueConfigName (String name) const;

  249. 

  250.     //==============================================================================

  251.     ValueTree getExporters();

  252.     int getNumExporters();

  253.     ProjectExporter* createExporter (int index);

  254.     void addNewExporter (const String& exporterName);

  255.     void deleteExporter (int index);

  256.     void createDefaultExporters();

  257. 

  258.     //==============================================================================

  259.     struct ConfigFlag

  260.     {

  261.         String symbol, description, sourceModuleID;

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

  263.     };

  264. 

  265.     static const char* const configFlagDefault;

  266.     static const char* const configFlagEnabled;

  267.     static const char* const configFlagDisabled;

  268.     Value getConfigFlag (const String& name);

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

  270. 

  271.     //==============================================================================

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

  273.     Value shouldShowAllModuleFilesInProject (const String& moduleID);

  274.     Value shouldCopyModuleFilesLocally (const String& moduleID);

  275. 

  276.     void addModule (const String& moduleID);

  277.     void removeModule (const String& moduleID);

  278. 

  279.     void createRequiredModules (const ModuleList& availableModules, OwnedArray<LibraryModule>& modules) const;

  280. 

  281.     //==============================================================================

  282.     String getFileTemplate (const String& templateName);

  283. 

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

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

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

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

  288.     void valueTreeChildOrderChanged (ValueTree& parentTree);

  289.     void valueTreeParentChanged (ValueTree& tree);

  290. 

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

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

  293. 

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

  295.     static const char* projectFileExtension;

  296. 

  297. private:

  298.     friend class Item;

  299.     ValueTree projectRoot;

  300.     static File lastDocumentOpened;

  301.     DrawableImage mainProjectIcon;

  302. 

  303.     void updateProjectSettings();

  304.     void sanitiseConfigFlags();

  305.     void setMissingDefaultValues();

  306.     ValueTree getConfigurations() const;

  307.     void createDefaultConfigs();

  308.     ValueTree getConfigNode();

  309.     ValueTree getModulesNode();

  310. 

  311.     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project);

  312. };

  313. 

  314. 

  315. #endif   // __JUCER_PROJECT_JUCEHEADER__