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
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <set>
#include <sstream>
#include <string>
#include <cm/string_view>
#include "cmCPackComponentGroup.h"
#include "cmCPackGenerator.h"
class cmXMLWriter;
/** \class cmCPackPKGGenerator
* \brief A generator for pkg files
*
*/
class cmCPackPKGGenerator : public cmCPackGenerator
{
public:
cmCPackTypeMacro(cmCPackPKGGenerator, cmCPackGenerator);
/**
* Construct generator
*/
cmCPackPKGGenerator();
~cmCPackPKGGenerator() override;
bool SupportsComponentInstallation() const override;
protected:
int InitializeInternal() override;
char const* GetOutputPostfix() override { return "darwin"; }
// Copies or creates the resource file with the given name to the
// package or package staging directory dirName. The variable
// CPACK_RESOURCE_FILE_${NAME} (where ${NAME} is the uppercased
// version of name) specifies the input file to use for this file,
// which will be configured via ConfigureFile.
bool CopyCreateResourceFile(std::string const& name,
std::string const& dirName);
bool CopyResourcePlistFile(std::string const& name,
char const* outName = nullptr);
int CopyInstallScript(std::string const& resdir, std::string const& script,
std::string const& name);
// Retrieve the name of package file that will be generated for this
// component. The name is just the file name with extension, and
// does not include the subdirectory.
std::string GetPackageName(cmCPackComponent const& component);
// Writes a distribution.dist file, which turns a metapackage into a
// full-fledged distribution. This file is used to describe
// inter-component dependencies. metapackageFile is the name of the
// metapackage for the distribution. Only valid for a
// component-based install.
void WriteDistributionFile(char const* metapackageFile, char const* genName);
// Subroutine of WriteDistributionFile that writes out the
// dependency attributes for inter-component dependencies.
void AddDependencyAttributes(cmCPackComponent const& component,
std::set<cmCPackComponent const*>& visited,
std::ostringstream& out);
// Subroutine of WriteDistributionFile that writes out the
// reverse dependency attributes for inter-component dependencies.
void AddReverseDependencyAttributes(
cmCPackComponent const& component,
std::set<cmCPackComponent const*>& visited, std::ostringstream& out);
// Generates XML that encodes the hierarchy of component groups and
// their components in a form that can be used by distribution
// metapackages.
void CreateChoiceOutline(cmCPackComponentGroup const& group,
cmXMLWriter& xout);
/// Create the "choice" XML element to describe a component group
/// for the installer GUI.
void CreateChoice(cmCPackComponentGroup const& group, cmXMLWriter& xout);
/// Create the "choice" XML element to describe a component for the
/// installer GUI.
void CreateChoice(cmCPackComponent const& component, cmXMLWriter& xout);
/// Creates a background in the distribution XML.
void CreateBackground(char const* themeName, char const* metapackageFile,
cm::string_view genName, cmXMLWriter& xout);
/// Create the "domains" XML element to indicate where the product can
/// be installed
void CreateDomains(cmXMLWriter& xout);
// The PostFlight component when creating a metapackage
cmCPackComponent PostFlightComponent;
};
|
