1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2015 - ROLI Ltd.
Permission is granted to use this software under the terms of either:
a) the GPL v2 (or any later version)
b) the Affero GPL v3
Details of these licenses can be found at: www.gnu.org/licenses
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
------------------------------------------------------------------------------
To release a closed-source product which uses JUCE, commercial licenses are
available: visit www.juce.com for more information.
==============================================================================
*/
#ifndef JUCER_PROJECT_H_INCLUDED
#define JUCER_PROJECT_H_INCLUDED
class ProjectExporter;
class ProjectType;
class LibraryModule;
class EnabledModuleList;
//==============================================================================
class Project : public FileBasedDocument,
public ValueTree::Listener
{
public:
//==============================================================================
Project (const File&);
~Project();
//==============================================================================
// FileBasedDocument stuff..
String getDocumentTitle() override;
Result loadDocument (const File& file) override;
Result saveDocument (const File& file) override;
Result saveProject (const File& file, bool isCommandLineApp);
Result saveResourcesOnly (const File& file);
File getLastDocumentOpened() override;
void setLastDocumentOpened (const File& file) override;
void setTitle (const String& newTitle);
//==============================================================================
File getProjectFolder() const { return getFile().getParentDirectory(); }
ValueTree getProjectRoot() const { return projectRoot; }
String getTitle() const;
Value getProjectNameValue() { return getMainGroup().getNameValue(); }
String getProjectFilenameRoot() { return File::createLegalFileName (getDocumentTitle()); }
String getProjectUID() const { return projectRoot [Ids::ID]; }
//==============================================================================
template <class FileType>
bool shouldBeAddedToBinaryResourcesByDefault (const FileType& file)
{
return ! file.hasFileExtension (sourceOrHeaderFileExtensions);
}
File resolveFilename (String filename) const;
String getRelativePathForFile (const File& file) const;
//==============================================================================
// Creates editors for the project settings
void createPropertyEditors (PropertyListBuilder&);
//==============================================================================
// project types
const ProjectType& getProjectType() const;
Value getProjectTypeValue() { return getProjectValue (Ids::projectType); }
String getProjectTypeString() const { return projectRoot [Ids::projectType]; }
Value getVersionValue() { return getProjectValue (Ids::version); }
String getVersionString() const { return projectRoot [Ids::version]; }
String getVersionAsHex() const;
int getVersionAsHexInteger() const;
Value getBundleIdentifier() { return getProjectValue (Ids::bundleIdentifier); }
String getDefaultBundleIdentifier() { return "com.yourcompany." + CodeHelpers::makeValidIdentifier (getTitle(), false, true, false); }
Value getAAXIdentifier() { return getProjectValue (Ids::aaxIdentifier); }
String getDefaultAAXIdentifier() { return getDefaultBundleIdentifier(); }
Value getCompanyName() { return getProjectValue (Ids::companyName); }
Value getCompanyWebsite() { return getProjectValue (Ids::companyWebsite); }
Value getCompanyEmail() { return getProjectValue (Ids::companyEmail); }
//==============================================================================
Value getProjectValue (const Identifier& name) { return projectRoot.getPropertyAsValue (name, getUndoManagerFor (projectRoot)); }
Value getProjectPreprocessorDefs() { return getProjectValue (Ids::defines); }
StringPairArray getPreprocessorDefs() const;
Value getProjectUserNotes() { return getProjectValue (Ids::userNotes); }
//==============================================================================
File getGeneratedCodeFolder() const { return getFile().getSiblingFile ("JuceLibraryCode"); }
File getSourceFilesFolder() const { return getProjectFolder().getChildFile ("Source"); }
File getLocalModulesFolder() const { return getGeneratedCodeFolder().getChildFile ("modules"); }
File getLocalModuleFolder (const String& moduleID) const { return getLocalModulesFolder().getChildFile (moduleID); }
File getAppIncludeFile() const { return getGeneratedCodeFolder().getChildFile (getJuceSourceHFilename()); }
File getBinaryDataCppFile (int index) const;
File getBinaryDataHeaderFile() const { return getBinaryDataCppFile (0).withFileExtension (".h"); }
Value getMaxBinaryFileSize() { return getProjectValue (Ids::maxBinaryFileSize); }
Value shouldIncludeBinaryInAppConfig() { return getProjectValue (Ids::includeBinaryInAppConfig); }
//==============================================================================
String getAppConfigFilename() const { return "AppConfig.h"; }
String getJuceSourceFilenameRoot() const { return "JuceLibraryCode"; }
String getJuceSourceHFilename() const { return "JuceHeader.h"; }
//==============================================================================
// Some helper methods for audio plugin/host projects.
Value shouldBuildVST() { return getProjectValue ("buildVST"); }
Value shouldBuildVST3() { return getProjectValue ("buildVST3"); }
Value shouldBuildAU() { return getProjectValue ("buildAU"); }
Value shouldBuildAUv3() { return getProjectValue ("buildAUv3"); }
Value shouldBuildRTAS() { return getProjectValue ("buildRTAS"); }
Value shouldBuildAAX() { return getProjectValue ("buildAAX"); }
Value shouldBuildStandalone() { return shouldBuildAUv3(); /* TODO: enable this when standalone becomes independent from AUv3: getProjectValue ("buildStandalone"); */}
Value getPluginName() { return getProjectValue ("pluginName"); }
Value getPluginDesc() { return getProjectValue ("pluginDesc"); }
Value getPluginManufacturer() { return getProjectValue ("pluginManufacturer"); }
Value getPluginManufacturerCode() { return getProjectValue ("pluginManufacturerCode"); }
Value getPluginCode() { return getProjectValue ("pluginCode"); }
Value getPluginChannelConfigs() { return getProjectValue ("pluginChannelConfigs"); }
Value getPluginIsSynth() { return getProjectValue ("pluginIsSynth"); }
Value getPluginWantsMidiInput() { return getProjectValue ("pluginWantsMidiIn"); }
Value getPluginProducesMidiOut() { return getProjectValue ("pluginProducesMidiOut"); }
Value getPluginIsMidiEffectPlugin() { return getProjectValue ("pluginIsMidiEffectPlugin"); }
Value getPluginEditorNeedsKeyFocus() { return getProjectValue ("pluginEditorRequiresKeys"); }
Value getPluginVSTCategory() { return getProjectValue ("pluginVSTCategory"); }
Value getPluginAUExportPrefix() { return getProjectValue ("pluginAUExportPrefix"); }
Value getPluginAUMainType() { return getProjectValue ("pluginAUMainType"); }
Value getPluginRTASCategory() { return getProjectValue ("pluginRTASCategory"); }
Value getPluginRTASBypassDisabled() { return getProjectValue ("pluginRTASDisableBypass"); }
Value getPluginRTASMultiMonoDisabled() { return getProjectValue ("pluginRTASDisableMultiMono"); }
Value getPluginAAXCategory() { return getProjectValue ("pluginAAXCategory"); }
Value getPluginAAXBypassDisabled() { return getProjectValue ("pluginAAXDisableBypass"); }
Value getPluginAAXMultiMonoDisabled() { return getProjectValue ("pluginAAXDisableMultiMono"); }
String getPluginRTASCategoryCode();
String getAUMainTypeString();
String getAUMainTypeCode();
String getPluginVSTCategoryString();
bool isAUPluginHost();
bool isVSTPluginHost();
bool isVST3PluginHost();
void updateDeprecatedProjectSettingsInteractively();
//==============================================================================
class Item
{
public:
//==============================================================================
Item (Project& project, const ValueTree& itemNode, bool isModuleCode);
Item (const Item& other);
static Item createGroup (Project& project, const String& name, const String& uid, bool isModuleCode);
void initialiseMissingProperties();
//==============================================================================
bool isValid() const { return state.isValid(); }
bool operator== (const Item& other) const { return state == other.state && &project == &other.project; }
bool operator!= (const Item& other) const { return ! operator== (other); }
//==============================================================================
bool isFile() const;
bool isGroup() const;
bool isMainGroup() const;
bool isImageFile() const;
String getID() const;
void setID (const String& newID);
Item findItemWithID (const String& targetId) const; // (recursive search)
String getImageFileID() const;
Drawable* loadAsImageFile() const;
//==============================================================================
Value getNameValue();
String getName() const;
File getFile() const;
String getFilePath() const;
void setFile (const File& file);
void setFile (const RelativePath& file);
File determineGroupFolder() const;
bool renameFile (const File& newFile);
bool shouldBeAddedToTargetProject() const;
bool shouldBeCompiled() const;
Value getShouldCompileValue();
bool shouldBeAddedToBinaryResources() const;
Value getShouldAddToBinaryResourcesValue();
bool shouldBeAddedToXcodeResources() const;
Value getShouldAddToXcodeResourcesValue();
Value getShouldInhibitWarningsValue();
bool shouldInhibitWarnings() const;
bool isModuleCode() const;
//==============================================================================
bool canContain (const Item& child) const;
int getNumChildren() const { return state.getNumChildren(); }
Item getChild (int index) const { return Item (project, state.getChild (index), belongsToModule); }
Item addNewSubGroup (const String& name, int insertIndex);
Item getOrCreateSubGroup (const String& name);
void addChild (const Item& newChild, int insertIndex);
bool addFileAtIndex (const File& file, int insertIndex, bool shouldCompile);
bool addFileRetainingSortOrder (const File& file, bool shouldCompile);
void addFileUnchecked (const File& file, int insertIndex, bool shouldCompile);
bool addRelativeFile (const RelativePath& file, int insertIndex, bool shouldCompile);
void removeItemFromProject();
void sortAlphabetically (bool keepGroupsAtStart, bool recursive);
Item findItemForFile (const File& file) const;
bool containsChildForFile (const RelativePath& file) const;
Item getParent() const;
Item createCopy();
UndoManager* getUndoManager() const { return project.getUndoManagerFor (state); }
Icon getIcon() const;
bool isIconCrossedOut() const;
Project& project;
ValueTree state;
private:
Item& operator= (const Item&);
bool belongsToModule;
};
Item getMainGroup();
void findAllImageItems (OwnedArray<Item>& items);
//==============================================================================
ValueTree getExporters();
int getNumExporters();
ProjectExporter* createExporter (int index);
void addNewExporter (const String& exporterName);
void createExporterForCurrentPlatform();
struct ExporterIterator
{
ExporterIterator (Project& project);
~ExporterIterator();
bool next();
ProjectExporter& operator*() const { return *exporter; }
ProjectExporter* operator->() const { return exporter; }
ScopedPointer<ProjectExporter> exporter;
int index;
private:
Project& project;
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ExporterIterator)
};
//==============================================================================
struct ConfigFlag
{
String symbol, description, sourceModuleID, defaultValue;
Value value; // 1 = true, 2 = false, anything else = use default
};
static const char* const configFlagDefault;
static const char* const configFlagEnabled;
static const char* const configFlagDisabled;
Value getConfigFlag (const String& name);
bool isConfigFlagEnabled (const String& name) const;
//==============================================================================
EnabledModuleList& getModules();
//==============================================================================
String getFileTemplate (const String& templateName);
//==============================================================================
PropertiesFile& getStoredProperties() const;
//==============================================================================
void valueTreePropertyChanged (ValueTree&, const Identifier&) override;
void valueTreeChildAdded (ValueTree&, ValueTree&) override;
void valueTreeChildRemoved (ValueTree&, ValueTree&, int) override;
void valueTreeChildOrderChanged (ValueTree&, int, int) override;
void valueTreeParentChanged (ValueTree&) override;
//==============================================================================
UndoManager* getUndoManagerFor (const ValueTree&) const { return nullptr; }
//==============================================================================
static const char* projectFileExtension;
//==============================================================================
bool hasProjectBeenModified();
void updateModificationTime() { modificationTime = getFile().getLastModificationTime(); }
private:
//==============================================================================
void setMissingAudioPluginDefaultValues();
void createAudioPluginPropertyEditors (PropertyListBuilder& props);
//==============================================================================
friend class Item;
ValueTree projectRoot;
ScopedPointer<EnabledModuleList> enabledModulesList;
bool isSaving;
void updateProjectSettings();
void sanitiseConfigFlags();
void setMissingDefaultValues();
ValueTree getConfigurations() const;
ValueTree getConfigNode();
void updateOldStyleConfigList();
void moveOldPropertyFromProjectToAllExporters (Identifier name);
void removeDefunctExporters();
void updateOldModulePaths();
void warnAboutOldProjucerVersion();
Time modificationTime;
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Project)
};
#endif // JUCER_PROJECT_H_INCLUDED
|
