1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include <map>
#include <memory>
#include <string>
#include "cmCPackGenerator.h"
#include "cmWIXPatch.h"
#include "cmWIXShortcut.h"
class cmWIXSourceWriter;
class cmWIXDirectoriesSourceWriter;
class cmWIXFilesSourceWriter;
class cmWIXFeaturesSourceWriter;
/** \class cmCPackWIXGenerator
* \brief A generator for WIX files
*/
class cmCPackWIXGenerator : public cmCPackGenerator
{
public:
cmCPackTypeMacro(cmCPackWIXGenerator, cmCPackGenerator);
cmCPackWIXGenerator();
cmCPackWIXGenerator(cmCPackWIXGenerator const&) = delete;
cmCPackWIXGenerator const& operator=(cmCPackWIXGenerator const&) = delete;
~cmCPackWIXGenerator();
protected:
int InitializeInternal() override;
int PackageFiles() override;
char const* GetOutputExtension() override { return ".msi"; }
enum CPackSetDestdirSupport SupportsSetDestdir() const override
{
return SETDESTDIR_UNSUPPORTED;
}
bool SupportsAbsoluteDestination() const override { return false; }
bool SupportsComponentInstallation() const override { return true; }
private:
using id_map_t = std::map<std::string, std::string>;
using ambiguity_map_t = std::map<std::string, size_t>;
using extension_set_t = std::set<std::string>;
using xmlns_map_t = std::map<std::string, std::string>;
enum class DefinitionType
{
STRING,
PATH
};
bool InitializeWiXConfiguration();
bool PackageFilesImpl();
bool PackageWithWix();
bool PackageWithWix3();
void CreateWiXVariablesIncludeFile();
void CreateWiXPropertiesIncludeFile();
void CreateWiXProductFragmentIncludeFile();
void CopyDefinition(cmWIXSourceWriter& source, std::string const& name,
DefinitionType type = DefinitionType::STRING);
void AddDefinition(cmWIXSourceWriter& source, std::string const& name,
std::string const& value);
bool CreateWiXSourceFiles();
std::string GetRootFolderId() const;
bool GenerateMainSourceFileFromTemplate();
bool CreateFeatureHierarchy(cmWIXFeaturesSourceWriter& featureDefinitions);
bool AddComponentsToFeature(
std::string const& rootPath, std::string const& featureId,
cmWIXDirectoriesSourceWriter& directoryDefinitions,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions, cmWIXShortcuts& shortcuts);
bool CreateShortcuts(std::string const& cpackComponentName,
std::string const& featureId,
cmWIXShortcuts const& shortcuts,
bool emitUninstallShortcut,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions);
bool CreateShortcutsOfSpecificType(
cmWIXShortcuts::Type type, std::string const& cpackComponentName,
std::string const& featureId, std::string const& idPrefix,
cmWIXShortcuts const& shortcuts, bool emitUninstallShortcut,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions);
void AppendUserSuppliedExtraSources();
void AppendUserSuppliedExtraObjects(std::ostream& stream);
bool CreateLicenseFile();
bool RunWiXCommand(std::string const& command);
bool RunCandleCommand(std::string const& sourceFile,
std::string const& objectFile);
bool RunLightCommand(std::string const& objectFiles);
void AddDirectoryAndFileDefinitions(
std::string const& topdir, std::string const& directoryId,
cmWIXDirectoriesSourceWriter& directoryDefinitions,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions,
std::vector<std::string> const& packageExecutables,
std::vector<std::string> const& desktopExecutables,
cmWIXShortcuts& shortcuts);
bool RequireOption(std::string const& name, std::string& value) const;
std::string GetArchitecture() const;
static std::string GenerateGUID();
static std::string QuotePath(std::string const& path);
static std::string GetRightmostExtension(std::string const& filename);
std::string PathToId(std::string const& path);
std::string CreateNewIdForPath(std::string const& path);
static std::string CreateHashedId(std::string const& path,
std::string const& normalizedFilename);
std::string NormalizeComponentForId(std::string const& component,
size_t& replacementCount);
static bool IsLegalIdCharacter(char c);
void CollectExtensions(std::string const& variableName,
extension_set_t& extensions);
void CollectXmlNamespaces(std::string const& variableName,
xmlns_map_t& namespaces);
void AddCustomFlags(std::string const& variableName, std::ostream& stream);
std::string RelativePathWithoutComponentPrefix(std::string const& path);
void InjectXmlNamespaces(cmWIXSourceWriter& sourceWriter);
std::vector<std::string> WixSources;
id_map_t PathToIdMap;
ambiguity_map_t IdAmbiguityCounter;
extension_set_t WixExtensions;
extension_set_t CandleExtensions;
extension_set_t LightExtensions;
xmlns_map_t CustomXmlNamespaces;
std::string CPackTopLevel;
std::unique_ptr<cmWIXPatch> Patch;
unsigned long WixVersion = 3;
cmWIXSourceWriter::GuidType ComponentGuidType;
};
|