kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CPackWIX: Refactor start menu and desktop shortcut creation.

This commit is contained in:
Nils Gladitz 2015-02-21 12:38:14 +01:00
parent dc0f3fb44f
commit 53d7daffac
7 changed files with 250 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Source/CMakeLists.txt
View File

@ -653,6 +653,7 @@ if(WIN32)
CPack/WiX/cmWIXPatchParser.h
CPack/WiX/cmWIXRichTextFormatWriter.cxx
CPack/WiX/cmWIXRichTextFormatWriter.h
CPack/WiX/cmWIXShortcut.cxx
CPack/WiX/cmWIXShortcut.h
CPack/WiX/cmWIXSourceWriter.cxx
CPack/WiX/cmWIXSourceWriter.h

181
Source/CPack/WiX/cmCPackWIXGenerator.cxx
View File

@ -33,7 +33,6 @@
#include <rpc.h> // for GUID generation
cmCPackWIXGenerator::cmCPackWIXGenerator():
HasDesktopShortcuts(false),
Patch(0)
{
@ -490,18 +489,16 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles()
featureDefinitions.EndElement("Feature");
bool hasShortcuts = false;
std::set<cmWIXShortcuts::Type> emittedShortcutTypes;
shortcut_map_t globalShortcuts;
cmWIXShortcuts globalShortcuts;
if(Components.empty())
{
AddComponentsToFeature(toplevel, "ProductFeature",
directoryDefinitions, fileDefinitions, featureDefinitions,
globalShortcuts);
if(globalShortcuts.size())
{
hasShortcuts = true;
}
globalShortcuts.AddShortcutTypes(emittedShortcutTypes);
}
else
{
@ -516,34 +513,30 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles()
std::string componentFeatureId = "CM_C_" + component.Name;
shortcut_map_t featureShortcuts;
cmWIXShortcuts featureShortcuts;
AddComponentsToFeature(componentPath, componentFeatureId,
directoryDefinitions, fileDefinitions,
featureDefinitions, featureShortcuts);
if(featureShortcuts.size())
{
hasShortcuts = true;
}
if(featureShortcuts.size())
{
if(!CreateStartMenuShortcuts(component.Name, componentFeatureId,
featureShortcuts, fileDefinitions, featureDefinitions))
featureShortcuts.AddShortcutTypes(emittedShortcutTypes);
if(!CreateShortcuts(component.Name, componentFeatureId,
featureShortcuts, false, fileDefinitions, featureDefinitions))
{
return false;
}
}
}
}
if(hasShortcuts)
{
if(!CreateStartMenuShortcuts(std::string(), "ProductFeature",
globalShortcuts, fileDefinitions, featureDefinitions))
bool emitUninstallShortcut = emittedShortcutTypes.find(
cmWIXShortcuts::START_MENU) != emittedShortcutTypes.end();
if(!CreateShortcuts(std::string(), "ProductFeature",
globalShortcuts, emitUninstallShortcut,
fileDefinitions, featureDefinitions))
{
return false;
}
}
featureDefinitions.EndElement("Fragment");
fileDefinitions.EndElement("Fragment");
@ -551,13 +544,15 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles()
directoryDefinitions.EndInstallationPrefixDirectory(
installRootSize);
if(hasShortcuts)
if(emittedShortcutTypes.find(cmWIXShortcuts::START_MENU) !=
emittedShortcutTypes.end())
{
directoryDefinitions.EmitStartMenuFolder(
GetOption("CPACK_WIX_PROGRAM_MENU_FOLDER"));
}
if(this->HasDesktopShortcuts)
if(emittedShortcutTypes.find(cmWIXShortcuts::DESKTOP) !=
emittedShortcutTypes.end())
{
directoryDefinitions.EmitDesktopFolder();
}
@ -649,7 +644,7 @@ bool cmCPackWIXGenerator::AddComponentsToFeature(
cmWIXDirectoriesSourceWriter& directoryDefinitions,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions,
shortcut_map_t& shortcutMap)
cmWIXShortcuts& shortcuts)
{
featureDefinitions.BeginElement("FeatureRef");
featureDefinitions.AddAttribute("Id", featureId);
@ -682,21 +677,68 @@ bool cmCPackWIXGenerator::AddComponentsToFeature(
rootPath, "INSTALL_ROOT",
directoryDefinitions, fileDefinitions, featureDefinitions,
cpackPackageExecutablesList, cpackPackageDesktopLinksList,
shortcutMap);
shortcuts);
featureDefinitions.EndElement("FeatureRef");
return true;
}
bool cmCPackWIXGenerator::CreateStartMenuShortcuts(
bool cmCPackWIXGenerator::CreateShortcuts(
std::string const& cpackComponentName,
std::string const& featureId,
shortcut_map_t& shortcutMap,
cmWIXShortcuts const& shortcuts,
bool emitUninstallShortcut,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions)
{
bool thisHasDesktopShortcuts = false;
if(!shortcuts.empty(cmWIXShortcuts::START_MENU))
{
if(!this->CreateShortcutsOfSpecificType(cmWIXShortcuts::START_MENU,
cpackComponentName, featureId, "",
shortcuts, emitUninstallShortcut,
fileDefinitions, featureDefinitions))
{
return false;
}
}
if(!shortcuts.empty(cmWIXShortcuts::DESKTOP))
{
if(!this->CreateShortcutsOfSpecificType(cmWIXShortcuts::DESKTOP,
cpackComponentName, featureId, "DESKTOP",
shortcuts, false,
fileDefinitions, featureDefinitions))
{
return false;
}
}
return true;
}
bool cmCPackWIXGenerator::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)
{
std::string directoryId;
switch(type)
{
case cmWIXShortcuts::START_MENU:
directoryId = "PROGRAM_MENU_FOLDER";
break;
case cmWIXShortcuts::DESKTOP:
directoryId = "DesktopFolder";
break;
default:
return false;
}
featureDefinitions.BeginElement("FeatureRef");
featureDefinitions.AddAttribute("Id", featureId);
@ -720,80 +762,42 @@ bool cmCPackWIXGenerator::CreateStartMenuShortcuts(
idSuffix += cpackComponentName;
}
std::string componentId = "CM_SHORTCUT" + idSuffix;
std::string componentId = "CM_SHORTCUT";
if(idPrefix.size())
{
componentId += "_" + idPrefix;
}
componentId += idSuffix;
fileDefinitions.BeginElement("DirectoryRef");
fileDefinitions.AddAttribute("Id", "PROGRAM_MENU_FOLDER");
fileDefinitions.AddAttribute("Id", directoryId);
fileDefinitions.BeginElement("Component");
fileDefinitions.AddAttribute("Id", componentId);
fileDefinitions.AddAttribute("Guid", "*");
for(shortcut_map_t::const_iterator
i = shortcutMap.begin(); i != shortcutMap.end(); ++i)
{
std::string const& id = i->first;
cmWIXShortcut const& shortcut = i->second;
std::string registryKey = std::string("Software\\") +
cpackVendor + "\\" + cpackPackageName;
fileDefinitions.EmitShortcut(id, shortcut, false);
shortcuts.EmitShortcuts(type, registryKey,
cpackComponentName, fileDefinitions);
if(shortcut.desktop)
if(type == cmWIXShortcuts::START_MENU)
{
thisHasDesktopShortcuts = true;
}
fileDefinitions.EmitRemoveFolder(
"CM_REMOVE_PROGRAM_MENU_FOLDER" + idSuffix);
}
if(cpackComponentName.empty())
if(emitUninstallShortcut)
{
fileDefinitions.EmitUninstallShortcut(cpackPackageName);
}
fileDefinitions.EmitRemoveFolder(
"CM_REMOVE_PROGRAM_MENU_FOLDER" + idSuffix);
std::string registryKey =
std::string("Software\\") + cpackVendor + "\\" + cpackPackageName;
fileDefinitions.EmitStartMenuShortcutRegistryValue(
registryKey, cpackComponentName);
fileDefinitions.EndElement("Component");
fileDefinitions.EndElement("DirectoryRef");
featureDefinitions.EmitComponentRef(componentId);
if(thisHasDesktopShortcuts)
{
this->HasDesktopShortcuts = true;
componentId = "CM_DESKTOP_SHORTCUT" + idSuffix;
fileDefinitions.BeginElement("DirectoryRef");
fileDefinitions.AddAttribute("Id", "DesktopFolder");
fileDefinitions.BeginElement("Component");
fileDefinitions.AddAttribute("Id", componentId);
fileDefinitions.AddAttribute("Guid", "*");
for(shortcut_map_t::const_iterator
i = shortcutMap.begin(); i != shortcutMap.end(); ++i)
{
std::string const& id = i->first;
cmWIXShortcut const& shortcut = i->second;
if (!shortcut.desktop)
continue;
fileDefinitions.EmitShortcut(id, shortcut, true);
}
fileDefinitions.EmitDesktopShortcutRegistryValue(
registryKey, cpackComponentName);
fileDefinitions.EndElement("Component");
fileDefinitions.EndElement("DirectoryRef");
featureDefinitions.EmitComponentRef(componentId);
}
featureDefinitions.EndElement("FeatureRef");
return true;
@ -854,7 +858,7 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons(
cmWIXFeaturesSourceWriter& featureDefinitions,
const std::vector<std::string>& packageExecutables,
const std::vector<std::string>& desktopExecutables,
shortcut_map_t& shortcutMap)
cmWIXShortcuts& shortcuts)
{
cmsys::Directory dir;
dir.Load(topdir.c_str());
@ -929,7 +933,7 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons(
featureDefinitions,
packageExecutables,
desktopExecutables,
shortcutMap);
shortcuts);
this->Patch->ApplyFragment(subDirectoryId, directoryDefinitions);
directoryDefinitions.EndElement("Directory");
@ -952,9 +956,10 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons(
if(cmSystemTools::LowerCase(fileName) ==
cmSystemTools::LowerCase(executableName) + ".exe")
{
cmWIXShortcut &shortcut = shortcutMap[id];
shortcut.textLabel= textLabel;
cmWIXShortcut shortcut;
shortcut.label= textLabel;
shortcut.workingDirectoryId = directoryId;
shortcuts.insert(cmWIXShortcuts::START_MENU, id, shortcut);
if(desktopExecutables.size() &&
std::find(desktopExecutables.begin(),
@ -962,7 +967,7 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons(
executableName)
!= desktopExecutables.end())
{
shortcut.desktop = true;
shortcuts.insert(cmWIXShortcuts::DESKTOP, id, shortcut);
}
}
}

26
Source/CPack/WiX/cmCPackWIXGenerator.h
View File

@ -65,7 +65,6 @@ protected:
private:
typedef std::map<std::string, std::string> id_map_t;
typedef std::map<std::string, size_t> ambiguity_map_t;
typedef std::map<std::string, cmWIXShortcut> shortcut_map_t;
typedef std::set<std::string> extension_set_t;
bool InitializeWiXConfiguration();
@ -99,12 +98,23 @@ private:
cmWIXDirectoriesSourceWriter& directoryDefinitions,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions,
shortcut_map_t& shortcutMap);
cmWIXShortcuts& shortcuts);
bool CreateStartMenuShortcuts(
bool CreateShortcuts(
std::string const& cpackComponentName,
std::string const& featureId,
shortcut_map_t& shortcutMap,
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);
@ -126,9 +136,9 @@ private:
cmWIXDirectoriesSourceWriter& directoryDefinitions,
cmWIXFilesSourceWriter& fileDefinitions,
cmWIXFeaturesSourceWriter& featureDefinitions,
const std::vector<std::string>& pkgExecutables,
const std::vector<std::string>& desktopExecutables,
shortcut_map_t& shortcutMap);
std::vector<std::string> const& pkgExecutables,
std::vector<std::string> const& desktopExecutables,
cmWIXShortcuts& shortcuts);
bool RequireOption(std::string const& name, std::string& value) const;
@ -165,8 +175,6 @@ private:
extension_set_t CandleExtensions;
extension_set_t LightExtensions;
bool HasDesktopShortcuts;
std::string CPackTopLevel;
cmWIXPatch* Patch;

31
Source/CPack/WiX/cmWIXFilesSourceWriter.cxx
View File

@ -1,6 +1,6 @@
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2014 Kitware, Inc.
Copyright 2014-2015 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
@ -28,18 +28,9 @@ cmWIXFilesSourceWriter::cmWIXFilesSourceWriter(cmCPackLog* logger,
void cmWIXFilesSourceWriter::EmitShortcut(
std::string const& id,
cmWIXShortcut const& shortcut,
bool desktop)
std::string const& shortcutPrefix)
{
std::string shortcutId;
if(desktop)
{
shortcutId = "CM_DS";
}
else
{
shortcutId = "CM_S";
}
std::string shortcutId = shortcutPrefix;
shortcutId += id;
@ -47,7 +38,7 @@ void cmWIXFilesSourceWriter::EmitShortcut(
BeginElement("Shortcut");
AddAttribute("Id", shortcutId);
AddAttribute("Name", shortcut.textLabel);
AddAttribute("Name", shortcut.label);
std::string target = "[#" + fileId + "]";
AddAttribute("Target", target);
AddAttribute("WorkingDirectory", shortcut.workingDirectoryId);
@ -62,20 +53,6 @@ void cmWIXFilesSourceWriter::EmitRemoveFolder(std::string const& id)
EndElement("RemoveFolder");
}
void cmWIXFilesSourceWriter::EmitStartMenuShortcutRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName)
{
EmitInstallRegistryValue(registryKey, cpackComponentName, std::string());
}
void cmWIXFilesSourceWriter::EmitDesktopShortcutRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName)
{
EmitInstallRegistryValue(registryKey, cpackComponentName, "_desktop");
}
void cmWIXFilesSourceWriter::EmitInstallRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName,

19
Source/CPack/WiX/cmWIXFilesSourceWriter.h
View File

@ -1,6 +1,6 @@
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2014 Kitware, Inc.
Copyright 2014-2015 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
@ -31,17 +31,14 @@ public:
void EmitShortcut(
std::string const& id,
cmWIXShortcut const& shortcut,
bool desktop);
std::string const& shortcutPrefix);
void EmitRemoveFolder(std::string const& id);
void EmitStartMenuShortcutRegistryValue(
void EmitInstallRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName);
void EmitDesktopShortcutRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName);
std::string const& cpackComponentName,
std::string const& suffix);
void EmitUninstallShortcut(std::string const& packageName);
@ -56,12 +53,6 @@ public:
std::string const& filePath,
cmWIXPatch &patch,
cmInstalledFile const* installedFile);
private:
void EmitInstallRegistryValue(
std::string const& registryKey,
std::string const& cpackComponentName,
std::string const& suffix);
};

86
Source/CPack/WiX/cmWIXShortcut.cxx Normal file
View File

@ -0,0 +1,86 @@
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2015 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "cmWIXShortcut.h"
#include "cmWIXFilesSourceWriter.h"
void cmWIXShortcuts::insert(
Type type, std::string const& id, cmWIXShortcut const& shortcut)
{
this->Shortcuts[type][id].push_back(shortcut);
}
bool cmWIXShortcuts::empty(Type type) const
{
return this->Shortcuts.find(type) == this->Shortcuts.end();
}
bool cmWIXShortcuts::EmitShortcuts(
Type type,
std::string const& registryKey,
std::string const& cpackComponentName,
cmWIXFilesSourceWriter& fileDefinitions) const
{
shortcut_type_map_t::const_iterator i = this->Shortcuts.find(type);
if(i == this->Shortcuts.end())
{
return false;
}
shortcut_id_map_t const& id_map = i->second;
std::string shortcutPrefix;
std::string registrySuffix;
switch(type)
{
case START_MENU:
shortcutPrefix = "CM_S";
break;
case DESKTOP:
shortcutPrefix = "CM_DS";
registrySuffix = "_desktop";
break;
default:
return false;
}
for(shortcut_id_map_t::const_iterator j = id_map.begin();
j != id_map.end(); ++j)
{
std::string const& id = j->first;
shortcut_list_t const& shortcutList = j->second;
for(shortcut_list_t::const_iterator k = shortcutList.begin();
k != shortcutList.end(); ++k)
{
cmWIXShortcut const& shortcut = *k;
fileDefinitions.EmitShortcut(id, shortcut, shortcutPrefix);
}
}
fileDefinitions.EmitInstallRegistryValue(
registryKey, cpackComponentName, registrySuffix);
return true;
}
void cmWIXShortcuts::AddShortcutTypes(std::set<Type>& types)
{
for(shortcut_type_map_t::const_iterator i = this->Shortcuts.begin();
i != this->Shortcuts.end(); ++i)
{
types.insert(i->first);
}
}

49
Source/CPack/WiX/cmWIXShortcut.h
View File

@ -1,6 +1,6 @@
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2014 Kitware, Inc.
Copyright 2014-2015 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
@ -10,20 +10,51 @@
See the License for more information.
============================================================================*/
#ifndef cmWIXFilesShortcut_h
#define cmWIXFilesShortcut_h
#ifndef cmWIXShortcut_h
#define cmWIXShortcut_h
#include <string>
#include <map>
#include <set>
#include <vector>
class cmWIXFilesSourceWriter;
struct cmWIXShortcut
{
cmWIXShortcut()
:desktop(false)
{}
std::string textLabel;
std::string label;
std::string workingDirectoryId;
bool desktop;
};
class cmWIXShortcuts
{
public:
enum Type
{
START_MENU,
DESKTOP
};
typedef std::vector<cmWIXShortcut> shortcut_list_t;
typedef std::map<std::string, shortcut_list_t> shortcut_id_map_t;
void insert(Type type, std::string const& id, cmWIXShortcut const& shortcut);
bool empty(Type type) const;
bool EmitShortcuts(
Type type,
std::string const& registryKey,
std::string const& cpackComponentName,
cmWIXFilesSourceWriter& fileDefinitions) const;
void AddShortcutTypes(std::set<Type>& types);
private:
typedef std::map<Type, shortcut_id_map_t> shortcut_type_map_t;
shortcut_type_map_t Shortcuts;
shortcut_id_map_t EmptyIdMap;
};
#endif