/* ============================================================================== This file is part of the JUCE framework. Copyright (c) Raw Material Software Limited JUCE is an open source framework subject to commercial or open source licensing. By downloading, installing, or using the JUCE framework, or combining the JUCE framework with any other source code, object code, content or any other copyrightable work, you agree to the terms of the JUCE End User Licence Agreement, and all incorporated terms including the JUCE Privacy Policy and the JUCE Website Terms of Service, as applicable, which will bind you. If you do not agree to the terms of these agreements, we will not license the JUCE framework to you, and you must discontinue the installation or download process and cease use of the JUCE framework. JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/ JUCE Privacy Policy: https://juce.com/juce-privacy-policy JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/ Or: You may also use this code under the terms of the AGPLv3: https://www.gnu.org/licenses/agpl-3.0.en.html THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED. ============================================================================== */ #pragma once #include "jucer_ProjectSaver.h" inline String msBuildEscape (String str) { // see https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-special-characters?view=vs-2019 for (const auto& special : { "%", "$", "@", "'", ";", "?", "\""}) str = str.replace (special, "%" + String::toHexString (*special)); return str; } inline StringArray msBuildEscape (StringArray range) { for (auto& i : range) i = msBuildEscape (i); return range; } class MSVCScriptBuilder { public: struct StringOrBuilder { StringOrBuilder() = default; StringOrBuilder (const String& s) : value (s) {} StringOrBuilder (const char* s) : StringOrBuilder (String { s }) {} StringOrBuilder (const MSVCScriptBuilder& sb) : StringOrBuilder (sb.build()) {} bool isNotEmpty() const { return value.isNotEmpty(); } String value; }; MSVCScriptBuilder& exit (int code) { script << "exit /b " << code; script << newLine; return *this; } MSVCScriptBuilder& deleteFile (const StringOrBuilder& path) { jassert (path.value.isQuotedString()); script << "del /s /q " << path.value; script << newLine; return *this; } MSVCScriptBuilder& mkdir (const StringOrBuilder& path) { jassert (path.value.isQuotedString()); script << "mkdir " << path.value; script << newLine; return *this; } MSVCScriptBuilder& delay (int timeSeconds) { script << "timeout /t " << String { timeSeconds } << " /nobreak"; script << newLine; return *this; } MSVCScriptBuilder& warning (const String& message) { script << "echo : Warning: " + message; script << newLine; return *this; } MSVCScriptBuilder& info (const String& message) { script << "echo : Info: " << message; script << newLine; return *this; } MSVCScriptBuilder& error (const String& message) { script << "echo : Error: " << message; script << newLine; return *this; } MSVCScriptBuilder& run (const StringOrBuilder& command, bool echo = false) { if (echo) script << "echo \"running " << command.value << "\"" << newLine; script << command.value; script << newLine; return *this; } template MSVCScriptBuilder& set (const String& name, T value) { script << "set " << name << "=" << value; script << newLine; return *this; } MSVCScriptBuilder& runAndCheck (const StringOrBuilder& command, const StringOrBuilder& success, const StringOrBuilder& failed = {}) { run (command.value); ifelse ("%ERRORLEVEL% equ 0", success.value, failed.value); return *this; } MSVCScriptBuilder& ifAllConditionsTrue (const StringArray& conditions, const StringOrBuilder& left) { jassert (left.isNotEmpty()); for (const auto& string : conditions) script << "if " << string << " "; script << "(" << newLine << left.value << ")"; script << newLine; return *this; } MSVCScriptBuilder& ifelse (const String& expr, const StringOrBuilder& left, const StringOrBuilder& right = {}) { jassert (left.isNotEmpty()); script << "if " << expr << " (" << newLine << left.value; if (right.isNotEmpty()) script << ") else (" << newLine << right.value << ")"; else script << ")"; script << newLine; return *this; } MSVCScriptBuilder& append (const StringOrBuilder& string) { if (string.isNotEmpty()) script << string.value << newLine; return *this; } MSVCScriptBuilder& labelledSection (const String& name, const StringOrBuilder& body) { script << ":" << name << newLine << body.value << newLine; return *this; } MSVCScriptBuilder& call (const String& label) { script << "call :" << label << newLine; return *this; } MSVCScriptBuilder& jump (const String& label) { script << "goto :" << label << newLine; return *this; } String build() const { MemoryOutputStream stream; build (stream); return stream.toUTF8(); } private: void build (OutputStream& stream) const { const auto genTab = [] (int depth, const int tabWidth = 4) { return String{}.paddedLeft (' ', depth * tabWidth); }; int depth = 0; auto lines = StringArray::fromLines (script); for (auto [lineIndex, line] : enumerate (lines)) { const auto trimmed = line.trim(); const auto enter = trimmed.endsWith ("("); const auto leave = trimmed.startsWith (")"); if (leave && depth > 0) depth--; if (trimmed.isNotEmpty()) { stream << genTab (depth) << trimmed; if (lineIndex < lines.size() - 1) stream << newLine; } if (enter) depth++; } } String script; }; enum class Architecture { win32, win64, arm64, arm64ec }; static String getArchitectureValueString (Architecture arch) { switch (arch) { case Architecture::win32: return "Win32"; case Architecture::win64: return "x64"; case Architecture::arm64: return "ARM64"; case Architecture::arm64ec: return "ARM64EC"; } jassertfalse; return ""; } static std::optional architectureTypeFromString (const String& string) { constexpr Architecture values[] { Architecture::win32, Architecture::win64, Architecture::arm64, Architecture::arm64ec }; for (auto value : values) { if (getArchitectureValueString (value) == string) return value; } jassertfalse; return {}; } static String getVisualStudioArchitectureId (Architecture architecture) { switch (architecture) { case Architecture::win32: return "x86"; case Architecture::win64: return "AMD64"; case Architecture::arm64: return "ARM64"; case Architecture::arm64ec: return "ARM64"; } jassertfalse; return ""; } static String getVisualStudioPlatformId (Architecture architecture) { switch (architecture) { case Architecture::win32: return "x86"; case Architecture::win64: return "x64"; case Architecture::arm64: return "ARM64"; case Architecture::arm64ec: return "ARM64EC"; } jassertfalse; return ""; } //============================================================================== class MSVCProjectExporterBase : public ProjectExporter { public: MSVCProjectExporterBase (Project& p, const ValueTree& t, String folderName) : ProjectExporter (p, t), IPPLibraryValue (settings, Ids::IPPLibrary, getUndoManager()), IPP1ALibraryValue (settings, Ids::IPP1ALibrary, getUndoManager()), MKL1ALibraryValue (settings, Ids::MKL1ALibrary, getUndoManager()), platformToolsetValue (settings, Ids::toolset, getUndoManager()), targetPlatformVersion (settings, Ids::windowsTargetPlatformVersion, getUndoManager()), manifestFileValue (settings, Ids::msvcManifestFile, getUndoManager()) { targetLocationValue.setDefault (getDefaultBuildsRootFolder() + folderName); } virtual int getVisualStudioVersion() const = 0; virtual String getSolutionComment() const = 0; virtual String getToolsVersion() const = 0; virtual String getDefaultToolset() const = 0; virtual String getDefaultWindowsTargetPlatformVersion() const = 0; virtual void getSupportedArchitectures (std::vector&) const = 0; //============================================================================== String getIPPLibrary() const { return IPPLibraryValue.get(); } String getIPP1ALibrary() const { return IPP1ALibraryValue.get(); } String getMKL1ALibrary() const { return MKL1ALibraryValue.get(); } String getPlatformToolset() const { return platformToolsetValue.get(); } String getWindowsTargetPlatformVersion() const { return targetPlatformVersion.get(); } //============================================================================== void addToolsetProperty (PropertyListBuilder& props, std::initializer_list valueStrings) { StringArray names; Array values; for (const auto& valueString : valueStrings) { names.add (valueString); values.add (valueString); } props.add (new ChoicePropertyComponent (platformToolsetValue, "Platform Toolset", names, values), "Specifies the version of the platform toolset that will be used when building this project.\n" "In order to use the ClangCL toolset, you must first install the \"C++ Clang Tools for Windows\" " "package using the Visual Studio Installer."); } void create (const OwnedArray&) const override { createResourcesAndIcon(); createPackagesConfigFile(); for (int i = 0; i < targets.size(); ++i) if (auto* target = targets[i]) target->writeProjectFile(); build_tools::writeStreamToFile (getSLNFile(), [&] (MemoryOutputStream& mo) { writeSolutionFile (mo, "11.00", getSolutionComment()); }); } //============================================================================== void updateDeprecatedSettings() override { { auto oldStylePrebuildCommand = getSettingString (Ids::prebuildCommand); settings.removeProperty (Ids::prebuildCommand, nullptr); if (oldStylePrebuildCommand.isNotEmpty()) for (ConfigIterator config (*this); config.next();) static_cast (&*config)->getValue (Ids::prebuildCommand) = oldStylePrebuildCommand; } { auto oldStyleLibName = getSettingString ("libraryName_Debug"); settings.removeProperty ("libraryName_Debug", nullptr); if (oldStyleLibName.isNotEmpty()) for (ConfigIterator config (*this); config.next();) if (config->isDebug()) config->getValue (Ids::targetName) = oldStyleLibName; } { auto oldStyleLibName = getSettingString ("libraryName_Release"); settings.removeProperty ("libraryName_Release", nullptr); if (oldStyleLibName.isNotEmpty()) for (ConfigIterator config (*this); config.next();) if (! config->isDebug()) config->getValue (Ids::targetName) = oldStyleLibName; } { std::vector toErase; for (const auto& config : getConfigurations()) { if (config.getProperty (Ids::winArchitecture) == "ARM") toErase.push_back (config); } if (! toErase.empty()) { for (const auto& e : toErase) e.getParent().removeChild (e, nullptr); getProject().addProjectMessage (ProjectMessages::Ids::unsupportedArm32Config, {}); } } for (ConfigIterator i (*this); i.next();) { auto& config = *static_cast (&*i); config.updateOldLTOSetting(); config.updateOldArchSetting(); } } Array getAllActiveArchitectures() const { Array archs; for (ConstConfigIterator i (*this); i.next();) { const auto& config = *static_cast (&*i); const auto configArchs = config.getArchitectures(); for (const auto& arch : configArchs) if (! archs.contains (arch)) archs.add (arch); } return archs; } void initialiseDependencyPathValues() override { vstLegacyPathValueWrapper.init ({ settings, Ids::vstLegacyFolder, nullptr }, getAppSettings().getStoredPath (Ids::vstLegacyPath, TargetOS::windows), TargetOS::windows); aaxPathValueWrapper.init ({ settings, Ids::aaxFolder, nullptr }, getAppSettings().getStoredPath (Ids::aaxPath, TargetOS::windows), TargetOS::windows); araPathValueWrapper.init ({ settings, Ids::araFolder, nullptr }, getAppSettings().getStoredPath (Ids::araPath, TargetOS::windows), TargetOS::windows); } //============================================================================== class MSVCBuildConfiguration final : public BuildConfiguration, private ValueTree::Listener { public: MSVCBuildConfiguration (Project& p, const ValueTree& settings, const ProjectExporter& e) : BuildConfiguration (p, settings, e), warningLevelValue (config, Ids::winWarningLevel, getUndoManager(), 4), warningsAreErrorsValue (config, Ids::warningsAreErrors, getUndoManager(), false), prebuildCommandValue (config, Ids::prebuildCommand, getUndoManager()), postbuildCommandValue (config, Ids::postbuildCommand, getUndoManager()), generateDebugSymbolsValue (config, Ids::alwaysGenerateDebugSymbols, getUndoManager(), true), enableIncrementalLinkingValue (config, Ids::enableIncrementalLinking, getUndoManager(), false), useRuntimeLibDLLValue (config, Ids::useRuntimeLibDLL, getUndoManager(), true), multiProcessorCompilationValue (config, Ids::multiProcessorCompilation, getUndoManager(), true), intermediatesPathValue (config, Ids::intermediatesPath, getUndoManager()), characterSetValue (config, Ids::characterSet, getUndoManager()), architectureTypeValue (config, Ids::winArchitecture, getUndoManager(), Array { getArchitectureValueString (Architecture::win64) }, ","), fastMathValue (config, Ids::fastMath, getUndoManager()), debugInformationFormatValue (config, Ids::debugInformationFormat, getUndoManager(), "ProgramDatabase"), pluginBinaryCopyStepValue (config, Ids::enablePluginBinaryCopyStep, getUndoManager(), false), intrinsicFunctionsEnabledValue (config, Ids::intrinsicFunctions, getUndoManager(), false), vstBinaryLocation (config, Ids::vstBinaryLocation, getUndoManager()), vst3BinaryLocation (config, Ids::vst3BinaryLocation, getUndoManager()), aaxBinaryLocation (config, Ids::aaxBinaryLocation, getUndoManager()), lv2BinaryLocation (config, Ids::lv2BinaryLocation, getUndoManager()), unityPluginBinaryLocation (config, Ids::unityPluginBinaryLocation, getUndoManager()) { constexpr std::tuple paths[] { { Architecture::win32, "%programfiles(x86)%", "%CommonProgramFiles(x86)%" }, { Architecture::win64, "%ProgramW6432%", "%CommonProgramW6432%" }, { Architecture::arm64, "%ProgramW6432%", "%CommonProgramW6432%" }, { Architecture::arm64ec, "%ProgramW6432%", "%CommonProgramW6432%" } }; for (const auto& [arch, programFolderPath, commonFolderPath] : paths) { setBinaryPathDefault (Ids::vstBinaryLocation, arch, programFolderPath + String ("\\Steinberg\\Vstplugins")); setBinaryPathDefault (Ids::vst3BinaryLocation, arch, commonFolderPath + String ("\\VST3")); setBinaryPathDefault (Ids::aaxBinaryLocation, arch, commonFolderPath + String ("\\Avid\\Audio\\Plug-Ins")); setBinaryPathDefault (Ids::lv2BinaryLocation, arch, "%APPDATA%\\LV2"); } optimisationLevelValue.setDefault (isDebug() ? optimisationOff : optimiseFull); config.addListener (this); } ~MSVCBuildConfiguration() override { config.removeListener (this); } void valueTreePropertyChanged (ValueTree&, const Identifier& property) override { if (property != Ids::winArchitecture) return; project.removeProjectMessage (ProjectMessages::Ids::arm64Warning); const auto selectedArchs = architectureTypeValue.get(); if (! selectedArchs.getArray()->contains (getArchitectureValueString (Architecture::arm64))) return; if (selectedArchs.getArray()->contains (getArchitectureValueString (Architecture::arm64ec))) return; project.addProjectMessage (ProjectMessages::Ids::arm64Warning, {}); } String getBinaryPath (const Identifier& id, Architecture arch) const { if (auto* location = getLocationForArchitecture (id, arch)) return location->get().toString(); return ""; } void setBinaryPathDefault (const Identifier& id, Architecture arch, const String& path) { if (auto* location = getLocationForArchitecture (id, arch)) location->setDefault (path); } //============================================================================== int getWarningLevel() const { return warningLevelValue.get(); } bool areWarningsTreatedAsErrors() const { return warningsAreErrorsValue.get(); } Array getArchitectures() const { auto value = architectureTypeValue.get(); auto* array = value.getArray(); if (array == nullptr) return {}; Array result; result.resize (array->size()); std::transform (array->begin(), array->end(), result.begin(), [] (const var& archVar) { return *architectureTypeFromString (archVar.toString()); }); return result; } String getPrebuildCommandString() const { return prebuildCommandValue.get(); } String getPostbuildCommandString() const { return postbuildCommandValue.get(); } String getIntermediatesPathString() const { return intermediatesPathValue.get(); } String getCharacterSetString() const { return characterSetValue.get(); } String getDebugInformationFormatString() const { return debugInformationFormatValue.get(); } bool shouldGenerateDebugSymbols() const { return generateDebugSymbolsValue.get(); } bool shouldLinkIncremental() const { return enableIncrementalLinkingValue.get(); } bool isUsingRuntimeLibDLL() const { return useRuntimeLibDLLValue.get(); } bool shouldUseMultiProcessorCompilation() const { return multiProcessorCompilationValue.get(); } bool isFastMathEnabled() const { return fastMathValue.get(); } bool isPluginBinaryCopyStepEnabled() const { return pluginBinaryCopyStepValue.get(); } bool isIntrinsicFunctionsEnabled() const { return intrinsicFunctionsEnabledValue.get(); } static bool shouldBuildTarget (build_tools::ProjectType::Target::Type targetType, Architecture arch) { return targetType != build_tools::ProjectType::Target::AAXPlugIn || (arch != Architecture::arm64 && arch != Architecture::arm64ec); } //============================================================================== String createMSVCConfigName (Architecture arch) const { return getName() + "|" + getArchitectureValueString (arch); } String getOutputFilename (const String& suffix, bool forceSuffix, build_tools::ProjectType::Target::Type type) const { using Target = build_tools::ProjectType::Target::Type; if (type == Target::LV2Helper) return Project::getLV2FileWriterName() + suffix; if (type == Target::VST3Helper) return Project::getVST3FileWriterName() + suffix; const auto forceUnityPrefix = type == Target::UnityPlugIn; auto target = File::createLegalFileName (getTargetBinaryNameString (forceUnityPrefix).trim()); if (forceSuffix || ! target.containsChar ('.')) return target.upToLastOccurrenceOf (".", false, false) + suffix; return target; } void createConfigProperties (PropertyListBuilder& props) override { if (project.isAudioPluginProject()) addVisualStudioPluginInstallPathProperties (props); const auto architectureList = std::invoke ([&] { std::vector result; static_cast (exporter).getSupportedArchitectures (result); return result; }); Array architectureListAsStrings; Array architectureListAsVars; for (const auto& arch : architectureList) { architectureListAsStrings.add (getArchitectureValueString (arch)); architectureListAsVars.add (getArchitectureValueString (arch)); } props.add (new MultiChoicePropertyComponent (architectureTypeValue, "Architecture", architectureListAsStrings, architectureListAsVars), "Which Windows architecture to use."); props.add (new ChoicePropertyComponentWithEnablement (debugInformationFormatValue, isDebug() ? isDebugValue : generateDebugSymbolsValue, "Debug Information Format", { "None", "C7 Compatible (/Z7)", "Program Database (/Zi)", "Program Database for Edit And Continue (/ZI)" }, { "None", "OldStyle", "ProgramDatabase", "EditAndContinue" }), "The type of debugging information created for your program for this configuration." " This will always be used in a debug configuration and will be used in a release configuration" " with forced generation of debug symbols."); props.add (new ChoicePropertyComponent (fastMathValue, "Relax IEEE Compliance"), "Enable this to use FAST_MATH non-IEEE mode. (Warning: this can have unexpected results!)"); props.add (new ChoicePropertyComponent (optimisationLevelValue, "Optimisation", { "Disabled (/Od)", "Minimise size (/O1)", "Maximise speed (/O2)", "Full optimisation (/Ox)" }, { optimisationOff, optimiseMinSize, optimiseMaxSpeed, optimiseFull }), "The optimisation level for this configuration"); props.add (new ChoicePropertyComponent (intrinsicFunctionsEnabledValue, "Intrinsic Functions"), "Replaces some function calls with intrinsic or otherwise special forms of the function that help your application run faster."); props.add (new TextPropertyComponent (intermediatesPathValue, "Intermediates Path", 2048, false), "An optional path to a folder to use for the intermediate build files. Note that Visual Studio allows " "you to use macros in this path, e.g. \"$(TEMP)\\MyAppBuildFiles\\$(Configuration)\", which is a handy way to " "send them to the user's temp folder."); props.add (new ChoicePropertyComponent (warningLevelValue, "Warning Level", { "Low", "Medium", "High" }, { 2, 3, 4 }), "The compilation warning level to use."); props.add (new ChoicePropertyComponent (warningsAreErrorsValue, "Treat Warnings as Errors"), "Enable this to treat compilation warnings as errors."); props.add (new ChoicePropertyComponent (useRuntimeLibDLLValue, "Runtime Library", { "Use static runtime", "Use DLL runtime" }, { false, true }), "If the static runtime is selected then your app/plug-in will not be dependent upon users having Microsoft's redistributable " "C++ runtime installed. However, if you are linking libraries from different sources you must select the same type of runtime " "used by the libraries."); props.add (new ChoicePropertyComponent (multiProcessorCompilationValue, "Multi-Processor Compilation", { "Enabled", "Disabled" }, { true, false }), "Allows the compiler to use of all the available processors, which can reduce compilation time. " "This is enabled by default and should only be disabled if you know what you are doing."); props.add (new ChoicePropertyComponent (enableIncrementalLinkingValue, "Incremental Linking"), "Enable to avoid linking from scratch for every new build. " "Disable to ensure that your final release build does not contain padding or thunks."); if (! isDebug()) { props.add (new ChoicePropertyComponent (generateDebugSymbolsValue, "Force Generation of Debug Symbols"), "Enable this to force generation of debug symbols in a release configuration."); } props.add (new TextPropertyComponent (prebuildCommandValue, "Pre-build Command", 2048, true), "Some command that will be run before a build starts."); props.add (new TextPropertyComponent (postbuildCommandValue, "Post-build Command", 2048, true), "Some command that will be run after a build starts."); props.add (new ChoicePropertyComponent (characterSetValue, "Character Set", { "MultiByte", "Unicode" }, { "MultiByte", "Unicode" }), "Specifies the character set used when building."); } String getModuleLibraryArchName() const override { String result ("$(Platform)\\"); result += isUsingRuntimeLibDLL() ? "MD" : "MT"; if (isDebug()) result += "d"; return result; } void updateOldLTOSetting() { if (! isDebug() && config.getPropertyAsValue ("wholeProgramOptimisation", nullptr) != Value()) linkTimeOptimisationValue = (static_cast (config ["wholeProgramOptimisation"]) == 0); } void updateOldArchSetting() { if (architectureTypeValue.get().isArray()) return; const auto archString = architectureTypeValue.get().toString(); const auto archType = architectureTypeFromString (archString); if (! archType) return; const auto pluginBinaryPathLocationIds = { Ids::vstBinaryLocation, Ids::vst3BinaryLocation, Ids::lv2BinaryLocation, Ids::aaxBinaryLocation, Ids::unityPluginBinaryLocation }; for (const auto& location : pluginBinaryPathLocationIds) { if (auto* prop = config.getPropertyPointer (location)) { setBinaryPathDefault (location, *archType, prop->toString()); } } architectureTypeValue = Array { archString }; } private: ValueTreePropertyWithDefault warningLevelValue, warningsAreErrorsValue, prebuildCommandValue, postbuildCommandValue, generateDebugSymbolsValue, enableIncrementalLinkingValue, useRuntimeLibDLLValue, multiProcessorCompilationValue, intermediatesPathValue, characterSetValue, architectureTypeValue, fastMathValue, debugInformationFormatValue, pluginBinaryCopyStepValue, intrinsicFunctionsEnabledValue; struct LocationProperties { LocationProperties (ValueTree& tree, const Identifier& propertyID, UndoManager* um) : win32 (tree, propertyID + "_Win32", um), x64 (tree, propertyID + "_x64", um), arm64 (tree, propertyID + "_arm64", um), arm64ec (tree, propertyID + "_arm64ec", um) { } const ValueTreePropertyWithDefault* get (Architecture arch) const { return get (*this, arch); } ValueTreePropertyWithDefault* get (Architecture arch) { return get (*this, arch); } ValueTreePropertyWithDefault win32, x64, arm64, arm64ec; private: template static auto get (This& t, Architecture arch) -> decltype (t.get (arch)) { switch (arch) { case Architecture::win32: return &t.win32; case Architecture::win64: return &t.x64; case Architecture::arm64: return &t.arm64; case Architecture::arm64ec: return &t.arm64ec; } jassertfalse; return nullptr; } }; template static auto getLocationForArchitecture (This& t, const Identifier& id, Architecture arch) { const auto properties = { std::pair { Ids::vstBinaryLocation, &t.vstBinaryLocation }, std::pair { Ids::vst3BinaryLocation, &t.vst3BinaryLocation }, std::pair { Ids::aaxBinaryLocation, &t.aaxBinaryLocation }, std::pair { Ids::lv2BinaryLocation, &t.lv2BinaryLocation }, std::pair { Ids::unityPluginBinaryLocation, &t.unityPluginBinaryLocation } }; const auto iter = std::find_if (properties.begin(), properties.end(), [id] (auto pair) { return id == pair.first; }); return iter != properties.end() ? iter->second->get (arch) : nullptr; } ValueTreePropertyWithDefault* getLocationForArchitecture (const Identifier& id, Architecture arch) { return getLocationForArchitecture (*this, id, arch); } const ValueTreePropertyWithDefault* getLocationForArchitecture (const Identifier& id, Architecture arch) const { return getLocationForArchitecture (*this, id, arch); } LocationProperties vstBinaryLocation, vst3BinaryLocation, aaxBinaryLocation, lv2BinaryLocation, unityPluginBinaryLocation; //============================================================================== void addVisualStudioPluginInstallPathProperties (PropertyListBuilder& props) { auto isBuildingAnyPlugins = (project.shouldBuildVST() || project.shouldBuildVST3() || project.shouldBuildAAX() || project.shouldBuildUnityPlugin()); if (isBuildingAnyPlugins) props.add (new ChoicePropertyComponent (pluginBinaryCopyStepValue, "Enable Plugin Copy Step"), "Enable this to copy plugin binaries to a specified folder after building."); const auto addLocationProperties = [&] (auto& locationProps, const String& format) { for (const auto& [member, arch] : { std::tuple (&LocationProperties::win32, Architecture::win32), std::tuple (&LocationProperties::x64, Architecture::win64), std::tuple (&LocationProperties::arm64, Architecture::arm64), std::tuple (&LocationProperties::arm64ec, Architecture::arm64ec) }) { const auto archAndFormat = getArchitectureValueString (arch) + " " + format; props.add (new TextPropertyComponentWithEnablement (locationProps.*member, pluginBinaryCopyStepValue, archAndFormat + " Binary Location", 1024, false), "The folder in which the compiled " + archAndFormat + " binary should be placed."); } }; if (project.shouldBuildVST3()) addLocationProperties (vst3BinaryLocation, "VST3"); if (project.shouldBuildAAX()) addLocationProperties (aaxBinaryLocation, "AAX"); if (project.shouldBuildLV2()) addLocationProperties (lv2BinaryLocation, "LV2"); if (project.shouldBuildUnityPlugin()) addLocationProperties (unityPluginBinaryLocation, "Unity"); if (project.shouldBuildVST()) addLocationProperties (vstBinaryLocation, "VST (Legacy)"); } }; //============================================================================== class MSVCTarget final : public build_tools::ProjectType::Target { public: MSVCTarget (build_tools::ProjectType::Target::Type targetType, const MSVCProjectExporterBase& exporter) : build_tools::ProjectType::Target (targetType), owner (exporter) { projectGuid = createGUID (owner.getProject().getProjectUIDString() + getName()); } virtual ~MSVCTarget() = default; String getProjectVersionString() const { return "10.00"; } String getProjectFileSuffix() const { return ".vcxproj"; } String getFiltersFileSuffix() const { return ".vcxproj.filters"; } String getTopLevelXmlEntity() const { return "Project"; } //============================================================================== void fillInProjectXml (XmlElement& projectXml) const { projectXml.setAttribute ("DefaultTargets", "Build"); projectXml.setAttribute ("ToolsVersion", getOwner().getToolsVersion()); projectXml.setAttribute ("xmlns", "http://schemas.microsoft.com/developer/msbuild/2003"); const auto allArchitectures = owner.getAllActiveArchitectures(); { auto* configsGroup = projectXml.createNewChildElement ("ItemGroup"); configsGroup->setAttribute ("Label", "ProjectConfigurations"); for (ConstConfigIterator i (owner); i.next();) { auto& config = *static_cast (&*i); for (const auto& arch : allArchitectures) { auto* e = configsGroup->createNewChildElement ("ProjectConfiguration"); e->setAttribute ("Include", config.createMSVCConfigName (arch)); e->createNewChildElement ("Configuration")->addTextElement (config.getName()); e->createNewChildElement ("Platform")->addTextElement (getArchitectureValueString (arch)); } } } { auto* globals = projectXml.createNewChildElement ("PropertyGroup"); globals->setAttribute ("Label", "Globals"); globals->createNewChildElement ("ProjectGuid")->addTextElement (getProjectGuid()); } { auto* imports = projectXml.createNewChildElement ("Import"); imports->setAttribute ("Project", "$(VCTargetsPath)\\Microsoft.Cpp.Default.props"); } if (owner.shouldAddMidiPackage()) { const auto path = "packages\\" + cppwinrtPackage.name + "." + cppwinrtPackage.version + "\\build\\native\\Microsoft.Windows.CppWinRT.props"; auto* imports = projectXml.createNewChildElement ("Import"); imports->setAttribute ("Project", path); imports->setAttribute ("Condition", "Exists('" + path + "')"); } for (ConstConfigIterator i (owner); i.next();) { auto& config = *static_cast (&*i); for (const auto& arch : allArchitectures) { auto* e = projectXml.createNewChildElement ("PropertyGroup"); setConditionAttribute (*e, config, arch); e->setAttribute ("Label", "Configuration"); e->createNewChildElement ("ConfigurationType")->addTextElement (getProjectType()); e->createNewChildElement ("UseOfMfc")->addTextElement ("false"); e->createNewChildElement ("WholeProgramOptimization")->addTextElement (config.isLinkTimeOptimisationEnabled() ? "true" : "false"); auto charSet = config.getCharacterSetString(); if (charSet.isNotEmpty()) e->createNewChildElement ("CharacterSet")->addTextElement (charSet); if (config.shouldLinkIncremental()) e->createNewChildElement ("LinkIncremental")->addTextElement ("true"); e->createNewChildElement ("PlatformToolset")->addTextElement (owner.getPlatformToolset()); addWindowsTargetPlatformToConfig (*e); struct IntelLibraryInfo { String libraryKind; String configString; }; for (const auto& info : { IntelLibraryInfo { owner.getIPPLibrary(), "UseIntelIPP" }, IntelLibraryInfo { owner.getIPP1ALibrary(), "UseIntelIPP1A" }, IntelLibraryInfo { owner.getMKL1ALibrary(), "UseInteloneMKL" } }) { if (info.libraryKind.isNotEmpty()) e->createNewChildElement (info.configString)->addTextElement (info.libraryKind); } } } { auto* e = projectXml.createNewChildElement ("Import"); e->setAttribute ("Project", "$(VCTargetsPath)\\Microsoft.Cpp.props"); } { auto* e = projectXml.createNewChildElement ("ImportGroup"); e->setAttribute ("Label", "ExtensionSettings"); } { auto* e = projectXml.createNewChildElement ("ImportGroup"); e->setAttribute ("Label", "PropertySheets"); auto* p = e->createNewChildElement ("Import"); p->setAttribute ("Project", "$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props"); p->setAttribute ("Condition", "exists('$(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props')"); p->setAttribute ("Label", "LocalAppDataPlatform"); } { auto* props = projectXml.createNewChildElement ("PropertyGroup"); props->createNewChildElement ("_ProjectFileVersion")->addTextElement ("10.0.30319.1"); props->createNewChildElement ("TargetExt")->addTextElement (getTargetSuffix()); for (ConstConfigIterator i (owner); i.next();) { auto& config = *static_cast (&*i); for (const auto& arch : allArchitectures) { if (getConfigTargetPath (config).isNotEmpty()) { auto* outdir = props->createNewChildElement ("OutDir"); setConditionAttribute (*outdir, config, arch); outdir->addTextElement (build_tools::windowsStylePath (getConfigTargetPath (config)) + "\\"); } { auto* intdir = props->createNewChildElement ("IntDir"); setConditionAttribute (*intdir, config, arch); auto intermediatesPath = getIntermediatesPath (config); if (! intermediatesPath.endsWithChar (L'\\')) intermediatesPath += L'\\'; intdir->addTextElement (build_tools::windowsStylePath (intermediatesPath)); } { auto* targetName = props->createNewChildElement ("TargetName"); setConditionAttribute (*targetName, config, arch); targetName->addTextElement (msBuildEscape (config.getOutputFilename ("", false, type))); } { auto* manifest = props->createNewChildElement ("GenerateManifest"); setConditionAttribute (*manifest, config, arch); manifest->addTextElement ("true"); } if (type != SharedCodeTarget) { auto librarySearchPaths = getLibrarySearchPaths (config); if (! librarySearchPaths.isEmpty()) { auto* libPath = props->createNewChildElement ("LibraryPath"); setConditionAttribute (*libPath, config, arch); libPath->addTextElement ("$(LibraryPath);" + librarySearchPaths.joinIntoString (";")); } } const auto enabled = config.getArchitectures().contains (arch) ? "true" : "false"; for (const auto optionName : { "PreBuildEventUseInBuild", "PostBuildEventUseInBuild" }) { auto* tag = props->createNewChildElement (optionName); setConditionAttribute (*tag, config, arch); tag->addTextElement (enabled); } } } } for (ConstConfigIterator i (owner); i.next();) { auto& config = *static_cast (&*i); for (const auto& arch : allArchitectures) { enum class EscapeQuotes { no, yes }; // VS doesn't correctly escape double quotes in preprocessor definitions, so we have // to add our own layer of escapes const auto addIncludePathsAndPreprocessorDefinitions = [this, &config] (XmlElement& xml, EscapeQuotes escapeQuotes) { auto includePaths = getOwner().getHeaderSearchPaths (config); includePaths.add ("%(AdditionalIncludeDirectories)"); xml.createNewChildElement ("AdditionalIncludeDirectories")->addTextElement (includePaths.joinIntoString (";")); const auto preprocessorDefs = getPreprocessorDefs (config, ";") + ";%(PreprocessorDefinitions)"; const auto preprocessorDefsEscaped = escapeQuotes == EscapeQuotes::yes ? preprocessorDefs.replace ("\"", "\\\"") : preprocessorDefs; xml.createNewChildElement ("PreprocessorDefinitions")->addTextElement (preprocessorDefsEscaped); }; bool isDebug = config.isDebug(); auto* group = projectXml.createNewChildElement ("ItemDefinitionGroup"); setConditionAttribute (*group, config, arch); { auto* midl = group->createNewChildElement ("Midl"); midl->createNewChildElement ("PreprocessorDefinitions")->addTextElement (isDebug ? "_DEBUG;%(PreprocessorDefinitions)" : "NDEBUG;%(PreprocessorDefinitions)"); midl->createNewChildElement ("MkTypLibCompatible")->addTextElement ("true"); midl->createNewChildElement ("SuppressStartupBanner")->addTextElement ("true"); midl->createNewChildElement ("TargetEnvironment")->addTextElement ("Win32"); midl->createNewChildElement ("HeaderFileName"); } bool isUsingEditAndContinue = false; const auto pdbFilename = getOwner().getIntDirFile (config, config.getOutputFilename (".pdb", true, type)); { auto* cl = group->createNewChildElement ("ClCompile"); cl->createNewChildElement ("Optimization")->addTextElement (getOptimisationLevelString (config.getOptimisationLevelInt())); const auto debugInfoFormat = isDebug || config.shouldGenerateDebugSymbols() ? config.getDebugInformationFormatString() : "None"; cl->createNewChildElement ("DebugInformationFormat")->addTextElement (debugInfoFormat); addIncludePathsAndPreprocessorDefinitions (*cl, EscapeQuotes::no); cl->createNewChildElement ("RuntimeLibrary")->addTextElement (config.isUsingRuntimeLibDLL() ? (isDebug ? "MultiThreadedDebugDLL" : "MultiThreadedDLL") : (isDebug ? "MultiThreadedDebug" : "MultiThreaded")); cl->createNewChildElement ("RuntimeTypeInfo")->addTextElement ("true"); cl->createNewChildElement ("PrecompiledHeader")->addTextElement ("NotUsing"); cl->createNewChildElement ("AssemblerListingLocation")->addTextElement ("$(IntDir)\\"); cl->createNewChildElement ("ObjectFileName")->addTextElement ("$(IntDir)\\"); cl->createNewChildElement ("ProgramDataBaseFileName")->addTextElement (pdbFilename); cl->createNewChildElement ("WarningLevel")->addTextElement ("Level" + String (config.getWarningLevel())); cl->createNewChildElement ("SuppressStartupBanner")->addTextElement ("true"); cl->createNewChildElement ("MultiProcessorCompilation")->addTextElement (config.shouldUseMultiProcessorCompilation() ? "true" : "false"); if (config.isFastMathEnabled()) cl->createNewChildElement ("FloatingPointModel")->addTextElement ("Fast"); auto extraFlags = getOwner().replacePreprocessorTokens (config, config.getAllCompilerFlagsString()).trim(); if (extraFlags.isNotEmpty()) cl->createNewChildElement ("AdditionalOptions")->addTextElement (extraFlags + " %(AdditionalOptions)"); if (config.areWarningsTreatedAsErrors()) cl->createNewChildElement ("TreatWarningAsError")->addTextElement ("true"); auto cppStandard = owner.project.getCppStandardString(); cl->createNewChildElement ("LanguageStandard")->addTextElement ("stdcpp" + cppStandard); if (config.isIntrinsicFunctionsEnabled()) cl->createNewChildElement ("IntrinsicFunctions")->addTextElement ("true"); } { auto* res = group->createNewChildElement ("ResourceCompile"); addIncludePathsAndPreprocessorDefinitions (*res, EscapeQuotes::yes); } auto externalLibraries = getExternalLibraries (config, getOwner().getExternalLibrariesStringArray()); auto additionalDependencies = type != SharedCodeTarget && type != LV2Helper && type != VST3Helper && ! externalLibraries.isEmpty() ? externalLibraries.joinIntoString (";") + ";%(AdditionalDependencies)" : String(); auto librarySearchPaths = config.getLibrarySearchPaths(); auto additionalLibraryDirs = type != SharedCodeTarget && type != LV2Helper && type != VST3Helper && librarySearchPaths.size() > 0 ? getOwner().replacePreprocessorTokens (config, librarySearchPaths.joinIntoString (";")) + ";%(AdditionalLibraryDirectories)" : String(); { auto* link = group->createNewChildElement ("Link"); link->createNewChildElement ("OutputFile")->addTextElement (getOutputFilePath (config)); link->createNewChildElement ("SuppressStartupBanner")->addTextElement ("true"); link->createNewChildElement ("IgnoreSpecificDefaultLibraries")->addTextElement (isDebug ? "libcmt.lib; msvcrt.lib;;%(IgnoreSpecificDefaultLibraries)" : "%(IgnoreSpecificDefaultLibraries)"); link->createNewChildElement ("GenerateDebugInformation")->addTextElement ((isDebug || config.shouldGenerateDebugSymbols()) ? "true" : "false"); link->createNewChildElement ("ProgramDatabaseFile")->addTextElement (pdbFilename); link->createNewChildElement ("SubSystem")->addTextElement (type == ConsoleApp || type == LV2Helper || type == VST3Helper ? "Console" : "Windows"); if (arch == Architecture::win32) link->createNewChildElement ("TargetMachine")->addTextElement ("MachineX86"); if (isUsingEditAndContinue) link->createNewChildElement ("ImageHasSafeExceptionHandlers")->addTextElement ("false"); if (! isDebug) { link->createNewChildElement ("OptimizeReferences")->addTextElement ("true"); link->createNewChildElement ("EnableCOMDATFolding")->addTextElement ("true"); } if (additionalLibraryDirs.isNotEmpty()) link->createNewChildElement ("AdditionalLibraryDirectories")->addTextElement (additionalLibraryDirs); link->createNewChildElement ("LargeAddressAware")->addTextElement ("true"); if (config.isLinkTimeOptimisationEnabled()) link->createNewChildElement ("LinkTimeCodeGeneration")->addTextElement ("UseLinkTimeCodeGeneration"); if (additionalDependencies.isNotEmpty()) link->createNewChildElement ("AdditionalDependencies")->addTextElement (additionalDependencies); auto extraLinkerOptions = config.getAllLinkerFlagsString(); if (extraLinkerOptions.isNotEmpty()) link->createNewChildElement ("AdditionalOptions")->addTextElement (getOwner().replacePreprocessorTokens (config, extraLinkerOptions).trim() + " %(AdditionalOptions)"); auto delayLoadedDLLs = getOwner().msvcDelayLoadedDLLs; if (delayLoadedDLLs.isNotEmpty()) link->createNewChildElement ("DelayLoadDLLs")->addTextElement (delayLoadedDLLs); auto moduleDefinitionsFile = getModuleDefinitions (config); if (moduleDefinitionsFile.isNotEmpty()) link->createNewChildElement ("ModuleDefinitionFile") ->addTextElement (moduleDefinitionsFile); } { auto* bsc = group->createNewChildElement ("Bscmake"); bsc->createNewChildElement ("SuppressStartupBanner")->addTextElement ("true"); bsc->createNewChildElement ("OutputFile")->addTextElement (getOwner().getIntDirFile (config, config.getOutputFilename (".bsc", true, type))); } if (type != SharedCodeTarget && type != LV2Helper && type != VST3Helper) { auto* lib = group->createNewChildElement ("Lib"); if (additionalDependencies.isNotEmpty()) lib->createNewChildElement ("AdditionalDependencies")->addTextElement (additionalDependencies); if (additionalLibraryDirs.isNotEmpty()) lib->createNewChildElement ("AdditionalLibraryDirectories")->addTextElement (additionalLibraryDirs); } if (auto manifestFile = getOwner().getManifestPath(); manifestFile.getRoot() != build_tools::RelativePath::unknown || type == VST3Helper) { auto* bsc = group->createNewChildElement ("Manifest"); auto* additional = bsc->createNewChildElement ("AdditionalManifestFiles"); if (manifestFile.getRoot() != build_tools::RelativePath::unknown) { additional->addTextElement (manifestFile.rebased (getOwner().getProject().getFile().getParentDirectory(), getOwner().getTargetFolder(), build_tools::RelativePath::buildTargetFolder).toWindowsStyle()); } } if (getTargetFileType() == staticLibrary && arch == Architecture::win32) { auto* lib = group->createNewChildElement ("Lib"); lib->createNewChildElement ("TargetMachine")->addTextElement ("MachineX86"); } auto preBuild = getPreBuildSteps (config, arch); if (preBuild.isNotEmpty()) group->createNewChildElement ("PreBuildEvent") ->createNewChildElement ("Command") ->addTextElement (preBuild); auto postBuild = getPostBuildSteps (config, arch); if (postBuild.isNotEmpty()) group->createNewChildElement ("PostBuildEvent") ->createNewChildElement ("Command") ->addTextElement (postBuild); } } std::unique_ptr otherFilesGroup (new XmlElement ("ItemGroup")); { auto* cppFiles = projectXml.createNewChildElement ("ItemGroup"); auto* headerFiles = projectXml.createNewChildElement ("ItemGroup"); writePrecompiledHeaderFiles (*cppFiles); for (int i = 0; i < getOwner().getAllGroups().size(); ++i) { auto& group = getOwner().getAllGroups().getReference (i); if (group.getNumChildren() > 0) addFilesToCompile (group, *cppFiles, *headerFiles, *otherFilesGroup); } if (type == LV2Helper) { const auto location = owner.rebaseFromProjectFolderToBuildTarget (owner.getLV2HelperProgramSource()) .toWindowsStyle(); cppFiles->createNewChildElement ("ClCompile")->setAttribute ("Include", location); } else if (type == VST3Helper) { const auto location = owner.rebaseFromProjectFolderToBuildTarget (owner.getVST3HelperProgramSource()) .toWindowsStyle(); cppFiles->createNewChildElement ("ClCompile")->setAttribute ("Include", location); } } if (getOwner().iconFile.existsAsFile()) { auto* e = otherFilesGroup->createNewChildElement ("None"); e->setAttribute ("Include", prependDot (getOwner().iconFile.getFileName())); } if (getOwner().packagesConfigFile.existsAsFile()) { auto* e = otherFilesGroup->createNewChildElement ("None"); e->setAttribute ("Include", getOwner().packagesConfigFile.getFileName()); } if (otherFilesGroup->getFirstChildElement() != nullptr) projectXml.addChildElement (otherFilesGroup.release()); if (type != SharedCodeTarget && getOwner().hasResourceFile()) { auto* rcGroup = projectXml.createNewChildElement ("ItemGroup"); auto* e = rcGroup->createNewChildElement ("ResourceCompile"); e->setAttribute ("Include", prependDot (getOwner().rcFile.getFileName())); } if (owner.shouldAddMidiPackage()) { auto* group = projectXml.createNewChildElement ("ItemGroup"); auto* reference = group->createNewChildElement ("Reference"); reference->setAttribute ("Include", midiPackage.name); auto* hintPath = reference->createNewChildElement ("HintPath"); hintPath->addTextElement ("packages\\" + midiPackage.name + "." + midiPackage.version + "\\ref\\native\\" + midiPackage.name + ".winmd"); auto* isWinmd = reference->createNewChildElement ("IsWinMDFile"); isWinmd->addTextElement ("true"); } { auto* e = projectXml.createNewChildElement ("Import"); e->setAttribute ("Project", "$(VCTargetsPath)\\Microsoft.Cpp.targets"); } std::vector packagesToInclude; owner.getPackagesToInclude (packagesToInclude); for (const auto& package : packagesToInclude) { auto* importGroup = projectXml.createNewChildElement ("ImportGroup"); importGroup->setAttribute ("Label", "ExtensionTargets"); const auto packageTargetsPath = "packages\\" + package.name + "." + package.version + "\\build\\native\\" + package.name + ".targets"; auto* e = importGroup->createNewChildElement ("Import"); e->setAttribute ("Project", packageTargetsPath); e->setAttribute ("Condition", "Exists('" + packageTargetsPath + "')"); } if (owner.shouldLinkWebView2Statically()) { auto* propertyGroup = projectXml.createNewChildElement ("PropertyGroup"); auto* loaderPref = propertyGroup->createNewChildElement ("WebView2LoaderPreference"); loaderPref->addTextElement ("Static"); } } String getProjectType() const { auto targetFileType = getTargetFileType(); if (targetFileType == executable) return "Application"; if (targetFileType == staticLibrary) return "StaticLibrary"; return "DynamicLibrary"; } //============================================================================== static void setSourceFilePCHSettings (XmlElement& element, const File& pchFile, const String& option, const BuildConfiguration& config, Architecture arch) { auto setConfigConditionAttribute = [&config, arch] (XmlElement* elementToSet) -> XmlElement* { setConditionAttribute (*elementToSet, config, arch); return elementToSet; }; setConfigConditionAttribute (element.createNewChildElement ("PrecompiledHeader"))->addTextElement (option); setConfigConditionAttribute (element.createNewChildElement ("PrecompiledHeaderFile"))->addTextElement (pchFile.getFileName()); setConfigConditionAttribute (element.createNewChildElement ("PrecompiledHeaderOutputFile"))->addTextElement ("$(Platform)\\$(Configuration)\\JucePrecompiledHeader.pch"); setConfigConditionAttribute (element.createNewChildElement ("ForcedIncludeFiles"))->addTextElement (pchFile.getFileName()); } void writePrecompiledHeaderFiles (XmlElement& cpps) const { for (ConstConfigIterator i (owner); i.next();) { if (! i->shouldUsePrecompiledHeaderFile()) continue; auto& config = *static_cast (&*i); auto pchFileContent = config.getPrecompiledHeaderFileContent(); if (pchFileContent.isEmpty()) continue; auto pchFile = owner.getTargetFolder().getChildFile (config.getPrecompiledHeaderFilename()) .withFileExtension (".h"); build_tools::writeStreamToFile (pchFile, [&] (MemoryOutputStream& mo) { mo << pchFileContent; }); auto pchSourceFile = pchFile.withFileExtension (".cpp"); build_tools::writeStreamToFile (pchSourceFile, [this] (MemoryOutputStream& mo) { mo.setNewLineString (owner.getNewLineString()); writeAutoGenWarningComment (mo); mo << " This is an empty source file generated by JUCE required for Visual Studio PCH." << newLine << newLine << "*/" << newLine << newLine; }); auto* pchSourceElement = cpps.createNewChildElement ("ClCompile"); pchSourceElement->setAttribute ("Include", prependDot (pchSourceFile.getFileName())); for (const auto& arch : config.getArchitectures()) setSourceFilePCHSettings (*pchSourceElement, pchFile, "Create", config, arch); } } void addFilesToCompile (const Project::Item& projectItem, XmlElement& cpps, XmlElement& headers, XmlElement& otherFiles) const { auto targetType = (getOwner().getProject().isAudioPluginProject() ? type : SharedCodeTarget); if (projectItem.isGroup()) { for (int i = 0; i < projectItem.getNumChildren(); ++i) addFilesToCompile (projectItem.getChild (i), cpps, headers, otherFiles); } else if (projectItem.shouldBeAddedToTargetProject() && projectItem.shouldBeAddedToTargetExporter (getOwner()) && getOwner().getProject().getTargetTypeFromFilePath (projectItem.getFile(), true) == targetType) { build_tools::RelativePath path (projectItem.getFile(), getOwner().getTargetFolder(), build_tools::RelativePath::buildTargetFolder); jassert (path.getRoot() == build_tools::RelativePath::buildTargetFolder); if (path.hasFileExtension (cOrCppFileExtensions) || path.hasFileExtension (asmFileExtensions)) { auto* e = cpps.createNewChildElement ("ClCompile"); e->setAttribute ("Include", path.toWindowsStyle()); if (projectItem.shouldBeCompiled()) { auto extraCompilerFlags = getOwner().getCompilerFlagsForProjectItem (projectItem); if (shouldAddBigobjFlag (path)) { const String bigobjFlag ("/bigobj"); if (! extraCompilerFlags.contains (bigobjFlag)) { extraCompilerFlags << " " << bigobjFlag; extraCompilerFlags.trim(); } } if (extraCompilerFlags.isNotEmpty()) e->createNewChildElement ("AdditionalOptions")->addTextElement (extraCompilerFlags + " %(AdditionalOptions)"); if (! projectItem.shouldSkipPCH()) { for (ConstConfigIterator i (owner); i.next();) { auto& config = *static_cast (&*i); if (config.shouldUsePrecompiledHeaderFile()) { for (const auto& arch : config.getArchitectures()) { auto pchFile = owner.getTargetFolder().getChildFile (i->getPrecompiledHeaderFilename()).withFileExtension (".h"); if (pchFile.existsAsFile()) setSourceFilePCHSettings (*e, pchFile, "Use", *i, arch); } } } } } else { e->createNewChildElement ("ExcludedFromBuild")->addTextElement ("true"); } } else if (path.hasFileExtension (headerFileExtensions)) { headers.createNewChildElement ("ClInclude")->setAttribute ("Include", path.toWindowsStyle()); } else if (! path.hasFileExtension (objCFileExtensions)) { otherFiles.createNewChildElement ("None")->setAttribute ("Include", path.toWindowsStyle()); } } } static void setConditionAttribute (XmlElement& xml, const BuildConfiguration& config, Architecture arch) { auto& msvcConfig = *static_cast (&config); xml.setAttribute ("Condition", "'$(Configuration)|$(Platform)'=='" + msvcConfig.createMSVCConfigName (arch) + "'"); } //============================================================================== void addFilterGroup (XmlElement& groups, const String& path) const { auto* e = groups.createNewChildElement ("Filter"); e->setAttribute ("Include", path); e->createNewChildElement ("UniqueIdentifier")->addTextElement (createGUID (path + "_guidpathsaltxhsdf")); } void addFileToFilter (const build_tools::RelativePath& file, const String& groupPath, XmlElement& cpps, XmlElement& headers, XmlElement& otherFiles) const { XmlElement* e = nullptr; if (file.hasFileExtension (headerFileExtensions)) e = headers.createNewChildElement ("ClInclude"); else if (file.hasFileExtension (sourceFileExtensions)) e = cpps.createNewChildElement ("ClCompile"); else e = otherFiles.createNewChildElement ("None"); jassert (file.getRoot() == build_tools::RelativePath::buildTargetFolder); e->setAttribute ("Include", file.toWindowsStyle()); e->createNewChildElement ("Filter")->addTextElement (groupPath); } bool addFilesToFilter (const Project::Item& projectItem, const String& path, XmlElement& cpps, XmlElement& headers, XmlElement& otherFiles, XmlElement& groups) const { auto targetType = (getOwner().getProject().isAudioPluginProject() ? type : SharedCodeTarget); if (projectItem.isGroup()) { bool filesWereAdded = false; for (int i = 0; i < projectItem.getNumChildren(); ++i) if (addFilesToFilter (projectItem.getChild (i), (path.isEmpty() ? String() : (path + "\\")) + projectItem.getChild (i).getName(), cpps, headers, otherFiles, groups)) filesWereAdded = true; if (filesWereAdded) addFilterGroup (groups, path); return filesWereAdded; } else if (projectItem.shouldBeAddedToTargetProject() && projectItem.shouldBeAddedToTargetExporter (getOwner()) && getOwner().getProject().getTargetTypeFromFilePath (projectItem.getFile(), true) == targetType) { build_tools::RelativePath relativePath (projectItem.getFile(), getOwner().getTargetFolder(), build_tools::RelativePath::buildTargetFolder); jassert (relativePath.getRoot() == build_tools::RelativePath::buildTargetFolder); addFileToFilter (relativePath, path.upToLastOccurrenceOf ("\\", false, false), cpps, headers, otherFiles); return true; } return false; } void fillInFiltersXml (XmlElement& filterXml) const { filterXml.setAttribute ("ToolsVersion", getOwner().getToolsVersion()); filterXml.setAttribute ("xmlns", "http://schemas.microsoft.com/developer/msbuild/2003"); auto* groupsXml = filterXml.createNewChildElement ("ItemGroup"); auto* cpps = filterXml.createNewChildElement ("ItemGroup"); auto* headers = filterXml.createNewChildElement ("ItemGroup"); std::unique_ptr otherFilesGroup (new XmlElement ("ItemGroup")); for (int i = 0; i < getOwner().getAllGroups().size(); ++i) { auto& group = getOwner().getAllGroups().getReference (i); if (group.getNumChildren() > 0) addFilesToFilter (group, group.getName(), *cpps, *headers, *otherFilesGroup, *groupsXml); } if (getOwner().iconFile.existsAsFile()) { auto* e = otherFilesGroup->createNewChildElement ("None"); e->setAttribute ("Include", prependDot (getOwner().iconFile.getFileName())); e->createNewChildElement ("Filter")->addTextElement (ProjectSaver::getJuceCodeGroupName()); } if (getOwner().packagesConfigFile.existsAsFile()) { auto* e = otherFilesGroup->createNewChildElement ("None"); e->setAttribute ("Include", getOwner().packagesConfigFile.getFileName()); } if (otherFilesGroup->getFirstChildElement() != nullptr) filterXml.addChildElement (otherFilesGroup.release()); if (type != SharedCodeTarget && getOwner().hasResourceFile()) { auto* rcGroup = filterXml.createNewChildElement ("ItemGroup"); auto* e = rcGroup->createNewChildElement ("ResourceCompile"); e->setAttribute ("Include", prependDot (getOwner().rcFile.getFileName())); e->createNewChildElement ("Filter")->addTextElement (ProjectSaver::getJuceCodeGroupName()); } } const MSVCProjectExporterBase& getOwner() const { return owner; } const String& getProjectGuid() const { return projectGuid; } //============================================================================== void writeProjectFile() { { XmlElement projectXml (getTopLevelXmlEntity()); fillInProjectXml (projectXml); writeXmlOrThrow (projectXml, getVCProjFile(), "UTF-8", 10); } { XmlElement filtersXml (getTopLevelXmlEntity()); fillInFiltersXml (filtersXml); writeXmlOrThrow (filtersXml, getVCProjFiltersFile(), "UTF-8", 100); } } String getSolutionTargetPath (const BuildConfiguration& config) const { auto binaryPath = config.getTargetBinaryRelativePathString().trim(); if (binaryPath.isEmpty()) return "$(SolutionDir)$(Platform)\\$(Configuration)"; build_tools::RelativePath binaryRelPath (binaryPath, build_tools::RelativePath::projectFolder); if (binaryRelPath.isAbsolute()) return binaryRelPath.toWindowsStyle(); return prependDot (binaryRelPath.rebased (getOwner().projectFolder, getOwner().getTargetFolder(), build_tools::RelativePath::buildTargetFolder) .toWindowsStyle()); } String getConfigTargetPath (const MSVCBuildConfiguration& config) const { const auto result = getSolutionTargetPath (config) + "\\" + getName(); if (type == LV2PlugIn) return result + "\\" + config.getTargetBinaryNameString() + ".lv2"; return result; } /* Like getConfigTargetPath, but expands $(ProjectName) so that build products can be used in other projects where $(ProjectName) will expand to a different value. */ String getExpandedConfigTargetPath (const MSVCBuildConfiguration& config) const { return getConfigTargetPath (config).replace ("$(ProjectName)", getOwner().getProjectFileBaseName (getName())); } String getIntermediatesPath (const MSVCBuildConfiguration& config) const { auto intDir = (config.getIntermediatesPathString().isNotEmpty() ? config.getIntermediatesPathString() : "$(Platform)\\$(Configuration)"); if (! intDir.endsWithChar (L'\\')) intDir += L'\\'; return intDir + getName(); } static const char* getOptimisationLevelString (int level) { switch (level) { case optimiseMinSize: return "MinSpace"; case optimiseMaxSpeed: return "MaxSpeed"; case optimiseFull: return "Full"; default: return "Disabled"; } } String getTargetSuffix() const { auto fileType = getTargetFileType(); if (fileType == executable) return ".exe"; if (fileType == staticLibrary) return ".lib"; if (fileType == sharedLibraryOrDLL) return ".dll"; if (fileType == pluginBundle) { if (type == AAXPlugIn) return ".aaxdll"; return ".dll"; } return {}; } String getPreprocessorDefs (const BuildConfiguration& config, const String& joinString) const { auto defines = getOwner().msvcExtraPreprocessorDefs; defines.set ("WIN32", ""); defines.set ("_WINDOWS", ""); if (config.isDebug()) { defines.set ("DEBUG", ""); defines.set ("_DEBUG", ""); } else { defines.set ("NDEBUG", ""); } defines = mergePreprocessorDefs (defines, getOwner().getAllPreprocessorDefs (config, type)); if (getTargetFileType() == staticLibrary || getTargetFileType() == sharedLibraryOrDLL) defines.set("_LIB", ""); StringArray result; for (int i = 0; i < defines.size(); ++i) { auto def = defines.getAllKeys()[i]; auto value = defines.getAllValues()[i]; if (value.isNotEmpty()) def << "=" << value; result.add (def); } return result.joinIntoString (joinString); } //============================================================================== build_tools::RelativePath getAAXIconFile() const { const auto aaxSdk = owner.getAAXPathRelative(); build_tools::RelativePath projectIcon ("icon.ico", build_tools::RelativePath::buildTargetFolder); if (getOwner().getTargetFolder().getChildFile ("icon.ico").existsAsFile()) return projectIcon.rebased (getOwner().getTargetFolder(), getOwner().getProject().getProjectFolder(), build_tools::RelativePath::projectFolder); return aaxSdk.getChildFile ("Utilities").getChildFile ("PlugIn.ico"); } static bool shouldPerformCopyStepForPlugin (Target::Type pluginType, const MSVCBuildConfiguration& config, Architecture arch) { if (! config.isPluginBinaryCopyStepEnabled()) return false; const auto binaryLocationId = getPluginTypeInfo (pluginType).second; return binaryLocationId.isValid() && config.getBinaryPath (binaryLocationId, arch).isNotEmpty(); } String getExtraPostBuildSteps (const MSVCBuildConfiguration& config, Architecture arch) const { using Builder = MSVCScriptBuilder; const auto copyBuildOutputIntoBundle = [&] (const StringArray& segments) { return "copy /Y " + getOutputFilePath (config).quoted() + " " + getOwner().getOutDirFile (config, segments.joinIntoString ("\\")).quoted(); }; const auto copyBundleToInstallDirectory = [&] (const StringArray& segments, const String& directory) { const auto copyStep = "\r\nxcopy /E /H /K /R /Y /I " + getOwner().getOutDirFile (config, segments[0]).quoted() + " " + (directory + "\\" + segments[0] + "\\").quoted(); return shouldPerformCopyStepForPlugin (type, config, arch) ? copyStep : ""; }; if (type == AAXPlugIn) { const auto aaxSdk = owner.getAAXPathRelative(); const auto aaxLibsFolder = aaxSdk.getChildFile ("Libs"); const auto bundleScript = aaxSdk.getChildFile ("Utilities").getChildFile ("CreatePackage.bat"); const auto iconFilePath = getAAXIconFile(); const auto segments = getAaxBundleStructure (config, arch); const auto pkgScript = copyBuildOutputIntoBundle (segments); const auto archDir = StringArray (segments.strings.data(), segments.size() - 1).joinIntoString ("\\"); const auto rebasedArchDir = getOwner().getOutDirFile (config, archDir); const auto fixScript = "\r\ncall " + createRebasedPath (bundleScript) + " " + rebasedArchDir.quoted() + String (" ") + createRebasedPath (iconFilePath); const auto copyScript = copyBundleToInstallDirectory (segments, config.getBinaryPath (Ids::aaxBinaryLocation, arch)); return pkgScript + fixScript + copyScript; } if (type == UnityPlugIn) { build_tools::RelativePath scriptPath (config.project.getGeneratedCodeFolder().getChildFile (config.project.getUnityScriptName()), getOwner().getTargetFolder(), build_tools::RelativePath::projectFolder); auto pkgScript = String ("copy /Y ") + scriptPath.toWindowsStyle().quoted() + " \"$(OutDir)\""; if (shouldPerformCopyStepForPlugin (type, config, arch)) { auto copyLocation = config.getBinaryPath (Ids::unityPluginBinaryLocation, arch); pkgScript += "\r\ncopy /Y \"$(OutDir)$(TargetFileName)\" " + String (copyLocation + "\\$(TargetFileName)").quoted(); pkgScript += "\r\ncopy /Y " + String ("$(OutDir)" + config.project.getUnityScriptName()).quoted() + " " + String (copyLocation + "\\" + config.project.getUnityScriptName()).quoted(); } return pkgScript; } if (type == LV2PlugIn) { const auto* writerTarget = [&]() -> MSVCTarget* { for (auto* target : owner.targets) if (target->type == LV2Helper) return target; return nullptr; }(); Builder builder; const auto writer = (writerTarget->getExpandedConfigTargetPath (config) + "\\" + writerTarget->getBinaryNameWithSuffix (config)).quoted() + " \"$(OutDir)$(TargetFileName)\"\r\n"; const auto copyStep = "xcopy /E /H /I /K /R /Y \"$(OutDir)\" \"" + config.getBinaryPath (Ids::lv2BinaryLocation, arch) + '\\' + config.getTargetBinaryNameString() + ".lv2\"\r\n"; builder.runAndCheck (writer, shouldPerformCopyStepForPlugin (type, config, arch) ? copyStep : Builder{}.info ("Successfully generated LV2 manifest").build(), Builder{}.error ("Failed to generate LV2 manifest.") .exit (-1)); return builder.build(); } if (type == VST3PlugIn) { const auto segments = getVst3BundleStructure (config, arch); const auto manifestScript = [&]() -> String { const auto* writerTarget = [&]() -> MSVCTarget* { for (auto* target : owner.targets) if (target->type == VST3Helper) return target; return nullptr; }(); if (writerTarget == nullptr) return ""; const auto helperExecutablePath = writerTarget->getExpandedConfigTargetPath (config) + "\\" + writerTarget->getBinaryNameWithSuffix (config); { const auto normalisedBundlePath = getOwner().getOutDirFile (config, segments[0]); const auto contentsDir = normalisedBundlePath + "\\Contents"; const auto resourceDir = contentsDir + "\\Resources"; const auto manifestPath = (resourceDir + "\\moduleinfo.json"); const auto resourceDirPath = resourceDir + "\\"; const auto pluginName = getOwner().project.getPluginNameString(); const auto manifestInvocationString = StringArray { helperExecutablePath.quoted(), ">", manifestPath.quoted() }.joinIntoString (" "); const auto crossCompilationPairs = { // This catches ARM64 and EC for x64 manifest generation std::pair { Architecture::arm64, Architecture::win64 }, std::pair { arch, arch } }; Builder builder; builder.set ("manifest_generated", 0); for (auto [hostArch, targetArch] : crossCompilationPairs) { const StringArray expr { "\"$(PROCESSOR_ARCHITECTURE)\" == " + getVisualStudioArchitectureId (hostArch).quoted(), "\"$(Platform)\"" " == " + getVisualStudioPlatformId (targetArch).quoted() }; builder.ifAllConditionsTrue (expr, Builder{}.call ("_generate_manifest") .set ("manifest_generated", 1)); } const auto archMismatchErrorString = StringArray { "VST3 manifest generation is disabled for", pluginName, "because a", getVisualStudioArchitectureId (arch), "manifest helper cannot run on a host system", "processor detected to be $(PROCESSOR_ARCHITECTURE)." }.joinIntoString (" "); const auto architectureMatched = Builder{} .ifelse ("exist " + manifestPath.quoted(), Builder{}.deleteFile (manifestPath.quoted())) .ifelse ("not exist " + resourceDirPath.quoted(), Builder{}.mkdir (resourceDirPath.quoted())) .runAndCheck (manifestInvocationString, Builder{}.info ("Successfully generated a manifest for " + pluginName) .jump ("_continue"), Builder{}.info ("The manifest helper failed") .jump ("_continue")); builder.ifelse ("%manifest_generated% equ 0", Builder{}.jump ("_arch_mismatch")); builder.jump ("_continue"); builder.labelledSection ("_generate_manifest", architectureMatched); builder.labelledSection ("_arch_mismatch", Builder{}.info (archMismatchErrorString)); builder.labelledSection ("_continue", ""); return builder.build(); } }(); const auto pkgScript = copyBuildOutputIntoBundle (segments); const auto copyScript = copyBundleToInstallDirectory (segments, config.getBinaryPath (Ids::vst3BinaryLocation, arch)); return MSVCScriptBuilder{} .append (pkgScript) .append (manifestScript) .append (copyScript) .build(); } if (type == VSTPlugIn && shouldPerformCopyStepForPlugin (type, config, arch)) { const String copyCommand = "copy /Y \"$(OutDir)$(TargetFileName)\" \"" + config.getBinaryPath (Ids::vstBinaryLocation, arch) + "\\$(TargetFileName)\""; return MSVCScriptBuilder{} .mkdir (config.getBinaryPath (Ids::vstBinaryLocation, arch).quoted()) .append (copyCommand) .build(); } return {}; } static std::pair getPluginTypeInfo (Target::Type targetType) { if (targetType == AAXPlugIn) return { "AAX", Ids::aaxBinaryLocation }; if (targetType == VSTPlugIn) return { "VST (Legacy)", Ids::vstBinaryLocation }; if (targetType == VST3PlugIn) return { "VST3", Ids::vst3BinaryLocation }; if (targetType == UnityPlugIn) return { "Unity", Ids::unityPluginBinaryLocation }; if (targetType == LV2PlugIn) return { "LV2", Ids::lv2BinaryLocation }; return {}; } static String generatePluginCopyStepPathValidatorScript (Target::Type targetType, const MSVCBuildConfiguration& config, Architecture arch) { MSVCScriptBuilder builder; if (config.isPluginBinaryCopyStepEnabled()) { const auto [projectTypeString, binaryLocationId] = getPluginTypeInfo (targetType); if (projectTypeString.isNotEmpty()) { const auto binaryPath = config.getBinaryPath (binaryLocationId, arch); if (binaryPath.isEmpty()) { String warningMessage = "Plugin Configuration Warning: Plugin copy step is enabled but no target " "path is specified in the Projucer."; warningMessage << " This can be configured via the \"" << getArchitectureValueString (arch) << " " << projectTypeString << " " << "Binary Location\" option in the relevant Exporter configuration panel."; builder.warning (warningMessage.quoted()); } else { constexpr auto errorMessage = "Plugin Copy Step Failure: Either the install path does not exist or you " "do not have permission to write to the target directory. Ensure you " "have the necessary permissions to write to the directory, or choose " "a different install location (e.g., a folder in your user directory)."; MemoryOutputStream script; const auto validProjectName = build_tools::makeValidIdentifier (config.project.getProjectNameString(), false, true, false, false); const auto validPluginName = build_tools::makeValidIdentifier (projectTypeString, false, true, false, false); script << "set TOUCH_NAME=\".touch_\"" << validProjectName << "_" << validPluginName << "_" << "\"%RANDOM%\"" << newLine; String tempPath = binaryPath; tempPath << "\\%TOUCH_NAME%"; script << "(" << newLine; script << "echo \".\" > " << tempPath.quoted() << newLine; script << ") > nul 2>&1" << newLine; builder.append (script.toString()); builder.ifelse ("exist " + tempPath.quoted(), MSVCScriptBuilder{}.deleteFile (tempPath.quoted()), MSVCScriptBuilder{}.error (String { errorMessage }.quoted()) .exit (1)); } } } return builder.build(); } static String generateToolchainValidatorScript (Architecture arch) { MSVCScriptBuilder builder; if (arch == Architecture::win64) { const auto x86ToolchainErrorMessage = "echo : Warning: Toolchain configuration issue!" " You are using a 32-bit toolchain to compile a 64-bit target on a 64-bit system." " This may cause problems with the build system." " To resolve this, use the x64 version of MSBuild. You can invoke it directly at:" " \"/MSBuild/Current/Bin/amd64/MSBuild.exe\"" " Or, use the \"x64 Native Tools Command Prompt\" script."; builder.ifAllConditionsTrue ( { "\"$(PROCESSOR_ARCHITECTURE)\" == " + getVisualStudioArchitectureId (Architecture::win32).quoted(), // This only exists if the process is x86 but the host is x64. "defined PROCESSOR_ARCHITEW6432" }, MSVCScriptBuilder{}.append (x86ToolchainErrorMessage)); } return builder.build(); } String getExtraPreBuildSteps (const MSVCBuildConfiguration& config, Architecture arch) const { const auto createBundleStructure = [&] (const StringArray& segments) { auto directory = getOwner().getOutDirFile (config, ""); MSVCScriptBuilder script; std::for_each (segments.begin(), std::prev (segments.end()), [&] (const auto& s) { directory += (directory.isEmpty() ? "" : "\\") + s; script.ifelse ("not exist " + (directory + "\\").quoted(), MSVCScriptBuilder{}.deleteFile (directory.quoted()) .mkdir (directory.quoted()).build()); }); return script.build(); }; MSVCScriptBuilder builder; builder.append (generatePluginCopyStepPathValidatorScript (type, config, arch)); builder.append (generateToolchainValidatorScript (arch)); if (type == LV2PlugIn) { const auto crossCompilationPairs = { // This catches ARM64 and EC for x64 manifest generation std::pair { Architecture::arm64, Architecture::win64 }, std::pair { arch, arch } }; for (auto [hostArch, targetArch] : crossCompilationPairs) { const StringArray expr { "\"$(PROCESSOR_ARCHITECTURE)\" == " + getVisualStudioArchitectureId (hostArch).quoted(), "\"$(Platform)\"" " == " + getVisualStudioPlatformId (targetArch).quoted() }; builder.ifAllConditionsTrue (expr, MSVCScriptBuilder{}.jump ("_continue")); } builder.error (StringArray { "\"$(Platform)\"", "LV2 cross-compilation is not available on", "\"$(PROCESSOR_ARCHITECTURE)\" hosts." }.joinIntoString (" ")); builder.exit (-1); builder.labelledSection ("_continue", ""); return builder.build(); } if (type == UnityPlugIn) return builder.build(); if (type == AAXPlugIn) return builder.build() + "\r\n" + createBundleStructure (getAaxBundleStructure (config, arch)); if (type == VSTPlugIn) return builder.build(); if (type == VST3PlugIn) return builder.build() + "\r\n" + createBundleStructure (getVst3BundleStructure (config, arch)); return {}; } String getPostBuildSteps (const MSVCBuildConfiguration& config, Architecture arch) const { const auto post = config.getPostbuildCommandString(); const auto extra = getExtraPostBuildSteps (config, arch); if (post.isNotEmpty() || extra.isNotEmpty()) { return MSVCScriptBuilder{} .append (post.replace ("\n", "\r\n")) .append (extra) .build(); } return ""; } String getPreBuildSteps (const MSVCBuildConfiguration& config, Architecture arch) const { const auto pre = config.getPrebuildCommandString(); const auto extra = getExtraPreBuildSteps (config, arch); if (pre.isNotEmpty() || extra.isNotEmpty()) { return MSVCScriptBuilder{} .append (pre.replace ("\n", "\r\n")) .append (extra) .build(); } return ""; } String getBinaryNameWithSuffix (const MSVCBuildConfiguration& config) const { return config.getOutputFilename (getTargetSuffix(), true, type); } String getOutputFilePath (const MSVCBuildConfiguration& config) const { return getOwner().getOutDirFile (config, getBinaryNameWithSuffix (config)); } StringArray getLibrarySearchPaths (const MSVCBuildConfiguration& config) const { auto librarySearchPaths = config.getLibrarySearchPaths(); if (type != SharedCodeTarget && type != LV2Helper && type != VST3Helper) if (auto* shared = getOwner().getSharedCodeTarget()) librarySearchPaths.add (shared->getExpandedConfigTargetPath (config)); return librarySearchPaths; } /* Libraries specified in the Projucer don't get escaped automatically. To include a special character in the name of a library, you must use the appropriate escape code instead. Module and shared code library names are not preprocessed. Special characters in the names of these libraries will be toEscape as appropriate. */ StringArray getExternalLibraries (const MSVCBuildConfiguration& config, const StringArray& otherLibs) const { auto result = otherLibs; for (auto& i : result) i = getOwner().replacePreprocessorTokens (config, i).trim(); result.addArray (msBuildEscape (getOwner().getModuleLibs())); if (type != SharedCodeTarget && type != LV2Helper && type != VST3Helper) if (auto* shared = getOwner().getSharedCodeTarget()) result.add (msBuildEscape (shared->getBinaryNameWithSuffix (config))); return result; } String getModuleDefinitions (const MSVCBuildConfiguration& config) const { auto moduleDefinitions = config.config [Ids::msvcModuleDefinitionFile].toString(); if (moduleDefinitions.isNotEmpty()) return moduleDefinitions; return {}; } File getVCProjFile() const { return getOwner().getProjectFile (getProjectFileSuffix(), getName()); } File getVCProjFiltersFile() const { return getOwner().getProjectFile (getFiltersFileSuffix(), getName()); } String createRebasedPath (const build_tools::RelativePath& path) const { return getOwner().createRebasedPath (path); } void addWindowsTargetPlatformToConfig (XmlElement& e) const { auto target = owner.getWindowsTargetPlatformVersion(); if (target == "Latest") { auto* child = e.createNewChildElement ("WindowsTargetPlatformVersion"); child->setAttribute ("Condition", "'$(WindowsTargetPlatformVersion)' == ''"); child->addTextElement ("$([Microsoft.Build.Utilities.ToolLocationHelper]::GetLatestSDKTargetPlatformVersion('Windows', '10.0'))"); } else { e.createNewChildElement ("WindowsTargetPlatformVersion")->addTextElement (target); } } protected: StringArray getAaxBundleStructure (const MSVCBuildConfiguration& config, Architecture arch) const { const auto dllName = config.getOutputFilename (".aaxplugin", false, type); return { dllName, "Contents", getArchitectureValueString (arch), dllName }; } StringArray getVst3BundleStructure (const MSVCBuildConfiguration& config, Architecture arch) const { // These suffixes are defined in the VST3 SDK docs const auto suffix = std::invoke ([&]() -> String { switch (arch) { case Architecture::win32: return "x86"; case Architecture::win64: return "x86_64"; case Architecture::arm64: return "arm64"; case Architecture::arm64ec: return "arm64ec"; } jassertfalse; return {}; }); const auto dllName = config.getOutputFilename (".vst3", false, type); return { dllName, "Contents", suffix + "-win", dllName }; } const MSVCProjectExporterBase& owner; String projectGuid; }; //============================================================================== bool usesMMFiles() const override { return false; } bool canCopeWithDuplicateFiles() override { return false; } bool supportsUserDefinedConfigurations() const override { return true; } bool isXcode() const override { return false; } bool isVisualStudio() const override { return true; } bool isMakefile() const override { return false; } bool isAndroidStudio() const override { return false; } bool isAndroid() const override { return false; } bool isWindows() const override { return true; } bool isLinux() const override { return false; } bool isOSX() const override { return false; } bool isiOS() const override { return false; } bool supportsPrecompiledHeaders() const override { return true; } String getNewLineString() const override { return "\r\n"; } bool supportsTargetType (build_tools::ProjectType::Target::Type type) const override { using Target = build_tools::ProjectType::Target; switch (type) { case Target::StandalonePlugIn: case Target::GUIApp: case Target::ConsoleApp: case Target::StaticLibrary: case Target::SharedCodeTarget: case Target::AggregateTarget: case Target::VSTPlugIn: case Target::VST3PlugIn: case Target::VST3Helper: case Target::AAXPlugIn: case Target::UnityPlugIn: case Target::LV2PlugIn: case Target::LV2Helper: case Target::DynamicLibrary: return true; case Target::AudioUnitPlugIn: case Target::AudioUnitv3PlugIn: case Target::unspecified: default: break; } return false; } //============================================================================== build_tools::RelativePath getManifestPath() const { auto path = manifestFileValue.get().toString(); return path.isEmpty() ? build_tools::RelativePath() : build_tools::RelativePath (path, build_tools::RelativePath::projectFolder); } //============================================================================== bool launchProject() override { #if JUCE_WINDOWS // Don't launch if already open const auto foundDBFiles = getSLNFile().getSiblingFile (".vs").findChildFiles (File::findFiles, true, "*.opendb", File::FollowSymlinks::no); if (! foundDBFiles.isEmpty()) return false; return getSLNFile().startAsProcess(); #else return false; #endif } bool canLaunchProject() override { #if JUCE_WINDOWS return true; #else return false; #endif } void createExporterProperties (PropertyListBuilder& props) override { props.add (new TextPropertyComponent (manifestFileValue, "Manifest file", 8192, false), "Path to a manifest input file which should be linked into your binary (path is relative to jucer file)."); props.add (new ChoicePropertyComponent (IPPLibraryValue, "(deprecated) Use IPP Library", { "No", "Yes (Default Linking)", "Multi-Threaded Static Library", "Single-Threaded Static Library", "Multi-Threaded DLL", "Single-Threaded DLL" }, { var(), "true", "Parallel_Static", "Sequential", "Parallel_Dynamic", "Sequential_Dynamic" }), "This option is deprecated, use the \"Use IPP Library (oneAPI)\" option instead. " "Enable this to use Intel's Integrated Performance Primitives library, if you have an older version that was not supplied in the oneAPI toolkit."); props.add (new ChoicePropertyComponent (IPP1ALibraryValue, "Use IPP Library (oneAPI)", { "No", "Yes (Default Linking)", "Static Library", "Dynamic Library" }, { var(), "true", "Static_Library", "Dynamic_Library" }), "Enable this to use Intel's Integrated Performance Primitives library, supplied as part of the oneAPI toolkit."); props.add (new ChoicePropertyComponent (MKL1ALibraryValue, "Use MKL Library (oneAPI)", { "No", "Parallel", "Sequential", "Cluster" }, { var(), "Parallel", "Sequential", "Cluster" }), "Enable this to use Intel's MKL library, supplied as part of the oneAPI toolkit."); { auto isWindows10SDK = getVisualStudioVersion() > 14; props.add (new TextPropertyComponent (targetPlatformVersion, "Windows Target Platform", 20, false), String ("Specifies the version of the Windows SDK that will be used when building this project. ") + (isWindows10SDK ? "Leave this field empty to use the latest Windows 10 SDK installed on the build machine." : "The default value for this exporter is " + getDefaultWindowsTargetPlatformVersion())); } } enum OptimisationLevel { optimisationOff = 1, optimiseMinSize = 2, optimiseFull = 3, optimiseMaxSpeed = 4 }; //============================================================================== void addPlatformSpecificSettingsForProjectType (const build_tools::ProjectType& type) override { msvcExtraPreprocessorDefs.set ("_CRT_SECURE_NO_WARNINGS", ""); if (type.isCommandLineApp()) msvcExtraPreprocessorDefs.set ("_CONSOLE", ""); callForAllSupportedTargets ([this] (build_tools::ProjectType::Target::Type targetType) { if (targetType != build_tools::ProjectType::Target::AggregateTarget) targets.add (new MSVCTarget (targetType, *this)); }); // If you hit this assert, you tried to generate a project for an exporter // that does not support any of your targets! jassert (targets.size() > 0); } const MSVCTarget* getSharedCodeTarget() const { for (auto target : targets) if (target->type == build_tools::ProjectType::Target::SharedCodeTarget) return target; return nullptr; } bool hasTarget (build_tools::ProjectType::Target::Type type) const { for (auto target : targets) if (target->type == type) return true; return false; } static void createRCFile (const Project& p, const File& iconFile, const File& rcFile) { build_tools::ResourceRcOptions resourceRc; resourceRc.version = p.getVersionString(); resourceRc.companyName = p.getCompanyNameString(); resourceRc.companyCopyright = p.getCompanyCopyrightString(); resourceRc.projectName = p.getProjectNameString(); resourceRc.icon = iconFile; resourceRc.write (rcFile); } private: //============================================================================== String createRebasedPath (const build_tools::RelativePath& path) const { auto rebasedPath = rebaseFromProjectFolderToBuildTarget (path).toWindowsStyle(); return getVisualStudioVersion() < 10 // (VS10 automatically adds escape characters to the quotes for this definition) ? CppTokeniserFunctions::addEscapeChars (rebasedPath.quoted()) : CppTokeniserFunctions::addEscapeChars (rebasedPath).quoted(); } protected: //============================================================================== mutable File rcFile, iconFile, packagesConfigFile; OwnedArray targets; ValueTreePropertyWithDefault IPPLibraryValue, IPP1ALibraryValue, MKL1ALibraryValue, platformToolsetValue, targetPlatformVersion, manifestFileValue; String getProjectFileBaseName (const String& target) const { const auto filename = project.getProjectFilenameRootString(); return filename + (target.isNotEmpty() ? (String ("_") + target.removeCharacters (" ")) : ""); } File getProjectFile (const String& extension, const String& target) const { const auto filename = getProjectFileBaseName (target); return getTargetFolder().getChildFile (filename).withFileExtension (extension); } File getSLNFile() const { return getProjectFile (".sln", String()); } static String prependIfNotAbsolute (const String& file, const char* prefix) { if (File::isAbsolutePath (file) || file.startsWithChar ('$')) prefix = ""; return prefix + build_tools::windowsStylePath (file); } String getIntDirFile (const BuildConfiguration& config, const String& file) const { return prependIfNotAbsolute (replacePreprocessorTokens (config, file), "$(IntDir)\\"); } String getOutDirFile (const BuildConfiguration& config, const String& file) const { return prependIfNotAbsolute (replacePreprocessorTokens (config, file), "$(OutDir)\\"); } BuildConfiguration::Ptr createBuildConfig (const ValueTree& v) const override { return *new MSVCBuildConfiguration (project, v, *this); } StringArray getHeaderSearchPaths (const BuildConfiguration& config) const { auto searchPaths = extraSearchPaths; searchPaths.addArray (config.getHeaderSearchPaths()); return getCleanedStringArray (searchPaths); } String getTargetGuid (MSVCTarget::Type type) const { for (auto* target : targets) if (target != nullptr && target->type == type) return target->getProjectGuid(); return {}; } //============================================================================== void writeProjectDependencies (OutputStream& out) const { const auto sharedCodeGuid = getTargetGuid (MSVCTarget::SharedCodeTarget); const auto lv2HelperGuid = getTargetGuid (MSVCTarget::LV2Helper); const auto vst3HelperGuid = getTargetGuid (MSVCTarget::VST3Helper); for (int addingOtherTargets = 0; addingOtherTargets < (sharedCodeGuid.isNotEmpty() ? 2 : 1); ++addingOtherTargets) { for (int i = 0; i < targets.size(); ++i) { if (auto* target = targets[i]) { if (sharedCodeGuid.isEmpty() || (addingOtherTargets != 0) == (target->type != MSVCTarget::StandalonePlugIn)) { out << "Project(\"{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}\") = \"" << projectName << " - " << target->getName() << "\", \"" << target->getVCProjFile().getFileName() << "\", \"" << target->getProjectGuid() << '"' << newLine; if (sharedCodeGuid.isNotEmpty() && target->type != MSVCTarget::SharedCodeTarget && target->type != MSVCTarget::LV2Helper && target->type != MSVCTarget::VST3Helper) { out << "\tProjectSection(ProjectDependencies) = postProject" << newLine << "\t\t" << sharedCodeGuid << " = " << sharedCodeGuid << newLine; if (target->type == MSVCTarget::LV2PlugIn && lv2HelperGuid.isNotEmpty()) out << "\t\t" << lv2HelperGuid << " = " << lv2HelperGuid << newLine; if (target->type == MSVCTarget::VST3PlugIn && vst3HelperGuid.isNotEmpty()) out << "\t\t" << vst3HelperGuid << " = " << vst3HelperGuid << newLine; out << "\tEndProjectSection" << newLine; } out << "EndProject" << newLine; } } } } } void writeSolutionFile (OutputStream& out, const String& versionString, String commentString) const { const unsigned char bomBytes[] { CharPointer_UTF8::byteOrderMark1, CharPointer_UTF8::byteOrderMark2, CharPointer_UTF8::byteOrderMark3 }; for (const auto& byte : bomBytes) out.writeByte ((char) byte); if (commentString.isNotEmpty()) commentString += newLine; out << newLine << "Microsoft Visual Studio Solution File, Format Version " << versionString << newLine << commentString << newLine; writeProjectDependencies (out); out << "Global" << newLine << "\tGlobalSection(SolutionConfigurationPlatforms) = preSolution" << newLine; for (ConstConfigIterator i (*this); i.next();) { auto& config = *static_cast (&*i); for (const auto& arch : config.getArchitectures()) { auto configName = config.createMSVCConfigName (arch); out << "\t\t" << configName << " = " << configName << newLine; } } out << "\tEndGlobalSection" << newLine << "\tGlobalSection(ProjectConfigurationPlatforms) = postSolution" << newLine; const auto allArchitectures = getAllActiveArchitectures(); for (auto& target : targets) { for (ConstConfigIterator i (*this); i.next();) { auto& config = *static_cast (&*i); // Add a configuration for all projects but only mark the desired to be built. // We have to do this as VS will automatically add the entry anyway. for (const auto& arch : allArchitectures) { auto configName = config.createMSVCConfigName (arch); out << "\t\t" << target->getProjectGuid() << "." << configName << "." << "ActiveCfg" << " = " << configName << newLine; const auto shouldBuild = config.shouldBuildTarget (target->type, arch) && config.getArchitectures().contains (arch); if (shouldBuild) out << "\t\t" << target->getProjectGuid() << "." << configName << "." << "Build.0" << " = " << configName << newLine; } } } out << "\tEndGlobalSection" << newLine << "\tGlobalSection(SolutionProperties) = preSolution" << newLine << "\t\tHideSolutionNode = FALSE" << newLine << "\tEndGlobalSection" << newLine; out << "EndGlobal" << newLine; } //============================================================================== bool hasResourceFile() const { return ! projectType.isStaticLibrary(); } void createResourcesAndIcon() const { if (hasResourceFile()) { iconFile = getTargetFolder().getChildFile ("icon.ico"); build_tools::writeWinIcon (getIcons(), iconFile); rcFile = getTargetFolder().getChildFile ("resources.rc"); createRCFile (project, iconFile, rcFile); } } bool shouldAddWebView2Package() const { return project.getEnabledModules().isModuleEnabled ("juce_gui_extra") && ( project.isConfigFlagEnabled ("JUCE_USE_WIN_WEBVIEW2", false) || project.isConfigFlagEnabled ("JUCE_USE_WIN_WEBVIEW2_WITH_STATIC_LINKING", false)); } bool shouldLinkWebView2Statically() const { return project.getEnabledModules().isModuleEnabled ("juce_gui_extra") && project.isConfigFlagEnabled ("JUCE_USE_WIN_WEBVIEW2_WITH_STATIC_LINKING", false); } bool shouldAddMidiPackage() const { return project.getEnabledModules().isModuleEnabled ("juce_audio_devices") && project.isConfigFlagEnabled ("JUCE_USE_WINDOWS_MIDI_SERVICES", false); } struct NuGetPackage { String name; String version; bool targetFrameworkNative = false; }; inline static const NuGetPackage webviewPackage { "Microsoft.Web.WebView2", "1.0.3485.44", false }; inline static const NuGetPackage cppwinrtPackage { "Microsoft.Windows.CppWinRT", "2.0.240405.15", true }; inline static const NuGetPackage midiPackage { "Microsoft.Windows.Devices.Midi2", "1.0.3-preview-11.250228-237", false }; void getPackagesToInclude (std::vector& result) const { if (shouldAddWebView2Package()) result.push_back (webviewPackage); if (shouldAddMidiPackage()) { result.push_back (cppwinrtPackage); result.push_back (midiPackage); } } void createPackagesConfigFile() const { std::vector packagesToInclude; getPackagesToInclude (packagesToInclude); if (packagesToInclude.empty()) return; packagesConfigFile = getTargetFolder().getChildFile ("packages.config"); build_tools::writeStreamToFile (packagesConfigFile, [&packagesToInclude] (MemoryOutputStream& mo) { mo.setNewLineString ("\r\n"); mo << "" << newLine << "" << newLine; for (const auto& p : packagesToInclude) { mo << " " << newLine; } mo << "" << newLine; }); } static String prependDot (const String& filename) { return build_tools::isAbsolutePath (filename) ? filename : (".\\" + filename); } static bool shouldAddBigobjFlag (const build_tools::RelativePath& path) { const auto name = path.getFileNameWithoutExtension(); return name.equalsIgnoreCase ("include_juce_gui_basics") || name.equalsIgnoreCase ("include_juce_audio_processors") || name.equalsIgnoreCase ("include_juce_audio_processors_headless") || name.equalsIgnoreCase ("include_juce_core") || name.equalsIgnoreCase ("include_juce_graphics"); } StringArray getModuleLibs() const { StringArray result; for (auto& lib : windowsLibs) result.add (lib + ".lib"); return result; } JUCE_DECLARE_NON_COPYABLE (MSVCProjectExporterBase) }; //============================================================================== class MSVCProjectExporterVC2019 final : public MSVCProjectExporterBase { public: MSVCProjectExporterVC2019 (Project& p, const ValueTree& t) : MSVCProjectExporterBase (p, t, getTargetFolderName()) { name = getDisplayName(); targetPlatformVersion.setDefault (defaultTargetPlatform); platformToolsetValue.setDefault (defaultToolset); } static String getDisplayName() { return "Visual Studio 2019"; } static String getValueTreeTypeName() { return "VS2019"; } static String getTargetFolderName() { return "VisualStudio2019"; } Identifier getExporterIdentifier() const override { return getValueTreeTypeName(); } int getVisualStudioVersion() const override { return 16; } String getSolutionComment() const override { return "# Visual Studio Version 16"; } String getToolsVersion() const override { return "16.0"; } String getDefaultToolset() const override { return defaultToolset; } String getDefaultWindowsTargetPlatformVersion() const override { return defaultTargetPlatform; } void getSupportedArchitectures (std::vector& result) const override { result.insert (result.end(), { Architecture::win32, Architecture::win64, Architecture::arm64 }); } static MSVCProjectExporterVC2019* createForSettings (Project& projectToUse, const ValueTree& settingsToUse) { if (settingsToUse.hasType (getValueTreeTypeName())) return new MSVCProjectExporterVC2019 (projectToUse, settingsToUse); return nullptr; } void createExporterProperties (PropertyListBuilder& props) override { addToolsetProperty (props, { "v140", "v140_xp", "v141", "v141_xp", "v142", "ClangCL" }); MSVCProjectExporterBase::createExporterProperties (props); } private: const String defaultToolset { "v142" }, defaultTargetPlatform { "10.0" }; JUCE_DECLARE_NON_COPYABLE (MSVCProjectExporterVC2019) }; //============================================================================== class MSVCProjectExporterVC2022 final : public MSVCProjectExporterBase { public: MSVCProjectExporterVC2022 (Project& p, const ValueTree& t) : MSVCProjectExporterBase (p, t, getTargetFolderName()) { name = getDisplayName(); targetPlatformVersion.setDefault (defaultTargetPlatform); platformToolsetValue.setDefault (defaultToolset); } static String getDisplayName() { return "Visual Studio 2022"; } static String getValueTreeTypeName() { return "VS2022"; } static String getTargetFolderName() { return "VisualStudio2022"; } Identifier getExporterIdentifier() const override { return getValueTreeTypeName(); } int getVisualStudioVersion() const override { return 17; } String getSolutionComment() const override { return "# Visual Studio Version 17"; } String getToolsVersion() const override { return "17.0"; } String getDefaultToolset() const override { return defaultToolset; } String getDefaultWindowsTargetPlatformVersion() const override { return defaultTargetPlatform; } void getSupportedArchitectures (std::vector& result) const override { result.insert (result.end(), { Architecture::win32, Architecture::win64, Architecture::arm64, Architecture::arm64ec }); } static MSVCProjectExporterVC2022* createForSettings (Project& projectToUse, const ValueTree& settingsToUse) { if (settingsToUse.hasType (getValueTreeTypeName())) return new MSVCProjectExporterVC2022 (projectToUse, settingsToUse); return nullptr; } void createExporterProperties (PropertyListBuilder& props) override { addToolsetProperty (props, { "v140", "v140_xp", "v141", "v141_xp", "v142", "v143", "ClangCL" }); MSVCProjectExporterBase::createExporterProperties (props); } private: const String defaultToolset { "v143" }, defaultTargetPlatform { "10.0" }; JUCE_DECLARE_NON_COPYABLE (MSVCProjectExporterVC2022) }; //============================================================================== class MSVCProjectExporterVC2026 final : public MSVCProjectExporterBase { public: MSVCProjectExporterVC2026 (Project& p, const ValueTree& t) : MSVCProjectExporterBase (p, t, getTargetFolderName()) { name = getDisplayName(); targetPlatformVersion.setDefault (defaultTargetPlatform); platformToolsetValue.setDefault (defaultToolset); } static String getDisplayName() { return "Visual Studio 2026"; } static String getValueTreeTypeName() { return "VS2026"; } static String getTargetFolderName() { return "VisualStudio2026"; } Identifier getExporterIdentifier() const override { return getValueTreeTypeName(); } int getVisualStudioVersion() const override { return 18; } String getSolutionComment() const override { return "# Visual Studio Version 18"; } String getToolsVersion() const override { return "18.0"; } String getDefaultToolset() const override { return defaultToolset; } String getDefaultWindowsTargetPlatformVersion() const override { return defaultTargetPlatform; } void getSupportedArchitectures (std::vector& result) const override { result.insert (result.end(), { Architecture::win32, Architecture::win64, Architecture::arm64, Architecture::arm64ec }); } static MSVCProjectExporterVC2026* createForSettings (Project& projectToUse, const ValueTree& settingsToUse) { if (settingsToUse.hasType (getValueTreeTypeName())) return new MSVCProjectExporterVC2026 (projectToUse, settingsToUse); return nullptr; } void createExporterProperties (PropertyListBuilder& props) override { addToolsetProperty (props, { "v140", "v140_xp", "v141", "v141_xp", "v142", "v143", "v145", "ClangCL" }); MSVCProjectExporterBase::createExporterProperties (props); } private: const String defaultToolset { "v145" }, defaultTargetPlatform { "10.0" }; JUCE_DECLARE_NON_COPYABLE (MSVCProjectExporterVC2026) };