86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
160 lines
4.7 KiB
C++
160 lines
4.7 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmCPackWIXGenerator_h
|
|
#define cmCPackWIXGenerator_h
|
|
|
|
#include <CPack/cmCPackGenerator.h>
|
|
|
|
#include "cmWIXPatch.h"
|
|
#include "cmWIXShortcut.h"
|
|
|
|
#include <map>
|
|
#include <string>
|
|
|
|
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();
|
|
|
|
protected:
|
|
virtual int InitializeInternal();
|
|
|
|
virtual int PackageFiles();
|
|
|
|
virtual const char* GetOutputExtension() { return ".msi"; }
|
|
|
|
virtual enum CPackSetDestdirSupport SupportsSetDestdir() const
|
|
{
|
|
return SETDESTDIR_UNSUPPORTED;
|
|
}
|
|
|
|
virtual bool SupportsAbsoluteDestination() const { return false; }
|
|
|
|
virtual bool SupportsComponentInstallation() const { return true; }
|
|
|
|
private:
|
|
typedef std::map<std::string, std::string> id_map_t;
|
|
typedef std::map<std::string, size_t> ambiguity_map_t;
|
|
typedef std::set<std::string> extension_set_t;
|
|
|
|
bool InitializeWiXConfiguration();
|
|
|
|
bool PackageFilesImpl();
|
|
|
|
void CreateWiXVariablesIncludeFile();
|
|
|
|
void CreateWiXPropertiesIncludeFile();
|
|
|
|
void CreateWiXProductFragmentIncludeFile();
|
|
|
|
void CopyDefinition(cmWIXSourceWriter& source, std::string const& name);
|
|
|
|
void AddDefinition(cmWIXSourceWriter& source, std::string const& name,
|
|
std::string const& value);
|
|
|
|
bool CreateWiXSourceFiles();
|
|
|
|
std::string GetProgramFilesFolderId() 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 AddDirectoryAndFileDefinitons(
|
|
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 AddCustomFlags(std::string const& variableName, std::ostream& stream);
|
|
|
|
std::string RelativePathWithoutComponentPrefix(std::string const& path);
|
|
|
|
std::vector<std::string> WixSources;
|
|
id_map_t PathToIdMap;
|
|
ambiguity_map_t IdAmbiguityCounter;
|
|
|
|
extension_set_t CandleExtensions;
|
|
extension_set_t LightExtensions;
|
|
|
|
std::string CPackTopLevel;
|
|
|
|
cmWIXPatch* Patch;
|
|
|
|
cmWIXSourceWriter::GuidType ComponentGuidType;
|
|
};
|
|
|
|
#endif
|