juce/source/extras/Introjucer/Source/Project/jucer_ProjectExporter.h

   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_PROJECTEXPORTER_JUCEHEADER__
  27 #define __JUCER_PROJECTEXPORTER_JUCEHEADER__
  28
  29 #include "../jucer_Headers.h"
  30 #include "jucer_Project.h"
  31
  32
  33 //==============================================================================
  34 class ProjectExporter
  35 {
  36 protected:
  37     //==============================================================================
  38     ProjectExporter (Project& project, const ValueTree& settings);
  39
  40 public:
  41     virtual ~ProjectExporter();
  42
  43     static int getNumExporters();
  44     static const StringArray getExporterNames();
  45     static ProjectExporter* createNewExporter (Project& project, const int index);
  46
  47     static ProjectExporter* createExporter (Project& project, const ValueTree& settings);
  48     static ProjectExporter* createPlatformDefaultExporter (Project& project);
  49
  50     //=============================================================================
  51     virtual bool isDefaultFormatForCurrentOS() = 0;
  52     virtual bool isPossibleForCurrentProject() = 0;
  53     virtual bool usesMMFiles() const = 0;
  54     virtual void createPropertyEditors (Array <PropertyComponent*>& props);
  55     virtual void launchProject() = 0;
  56     virtual void create() = 0; // may throw a SaveError
  57     virtual bool shouldFileBeCompiledByDefault (const RelativePath& path) const;
  58
  59     //==============================================================================
  60     const String getName() const            { return name; }
  61     const File getTargetFolder() const;
  62
  63     const ValueTree& getSettings() const                { return settings; }
  64     Value getSetting (const Identifier& name_) const    { return settings.getPropertyAsValue (name_, project.getUndoManagerFor (settings)); }
  65
  66     Value getJuceFolder() const             { return getSetting (Ids::juceFolder); }
  67     Value getTargetLocation() const         { return getSetting (Ids::targetFolder); }
  68
  69     Value getVSTFolder() const              { return getSetting (Ids::vstFolder); }
  70     Value getRTASFolder() const             { return getSetting (Ids::rtasFolder); }
  71     Value getAUFolder() const               { return getSetting (Ids::auFolder); }
  72
  73     bool isVST() const                      { return (bool) project.isAudioPlugin() && (bool) project.shouldBuildVST().getValue(); }
  74     bool isRTAS() const                     { return (bool) project.isAudioPlugin() && (bool) project.shouldBuildRTAS().getValue(); }
  75     bool isAU() const                       { return (bool) project.isAudioPlugin() && (bool) project.shouldBuildAU().getValue(); }
  76
  77     Value getExtraCompilerFlags() const     { return getSetting (Ids::extraCompilerFlags); }
  78     Value getExtraLinkerFlags() const       { return getSetting (Ids::extraLinkerFlags); }
  79
  80     Value getExporterPreprocessorDefs() const   { return getSetting (Ids::extraDefs); }
  81
  82     // includes exporter, project + config defs
  83     const StringPairArray getAllPreprocessorDefs (const Project::BuildConfiguration& config) const;
  84     // includes exporter + project defs..
  85     const StringPairArray getAllPreprocessorDefs() const;
  86
  87     const String replacePreprocessorTokens (const Project::BuildConfiguration& config,
  88                                             const String& sourceString) const;
  89
  90     // This adds the quotes, and may return angle-brackets, eg: <foo/bar.h> or normal quotes.
  91     const String getIncludePathForFileInJuceFolder (const String& pathFromJuceFolder, const File& targetIncludeFile) const;
  92
  93     const String getExporterIdentifierMacro() const
  94     {
  95         return "JUCER_" + settings.getType().toString() + "_"
  96                 + String::toHexString (settings [Ids::targetFolder].toString().hashCode()).toUpperCase();
  97     }
  98
  99     Array<RelativePath> juceWrapperFiles;
 100     RelativePath juceWrapperFolder;
 101
 102     // An exception that can be thrown by the create() method.
 103     class SaveError
 104     {
 105     public:
 106         SaveError (const String& error) : message (error)
 107         {}
 108
 109         SaveError (const File& fileThatFailedToWrite)
 110             : message ("Can't write to the file: " + fileThatFailedToWrite.getFullPathName())
 111         {}
 112
 113         String message;
 114     };
 115
 116 protected:
 117     //==============================================================================
 118     Project& project;
 119     ValueTree settings;
 120     String name;
 121
 122     const RelativePath getJucePathFromTargetFolder() const;
 123
 124     static const String getDefaultBuildsRootFolder()            { return "Builds/"; }
 125
 126     const Array<RelativePath> getVSTFilesRequired() const;
 127
 128     static const String getLibbedFilename (String name)
 129     {
 130         if (! name.startsWith ("lib"))
 131             name = "lib" + name;
 132         if (! name.endsWithIgnoreCase (".a"))
 133             name = name + ".a";
 134         return name;
 135     }
 136
 137     const RelativePath rebaseFromProjectFolderToBuildTarget (const RelativePath& path) const;
 138
 139     //==============================================================================
 140     static void overwriteFileIfDifferentOrThrow (const File& file, const MemoryOutputStream& newData)
 141     {
 142         if (! FileHelpers::overwriteFileWithNewDataIfDifferent (file, newData))
 143             throw SaveError (file);
 144     }
 145
 146     static void createDirectoryOrThrow (const File& dirToCreate)
 147     {
 148         if (! dirToCreate.createDirectory())
 149             throw SaveError ("Can't create folder: " + dirToCreate.getFullPathName());
 150     }
 151
 152     static void writeXmlOrThrow (const XmlElement& xml, const File& file, const String& encoding, int maxCharsPerLine)
 153     {
 154         MemoryOutputStream mo;
 155         xml.writeToStream (mo, String::empty, false, true, encoding, maxCharsPerLine);
 156         overwriteFileIfDifferentOrThrow (file, mo);
 157     }
 158
 159 private:
 160     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ProjectExporter);
 161 };
 162
 163
 164 #endif   // __JUCER_PROJECTEXPORTER_JUCEHEADER__