mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-13 02:29:02 -06:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
95 lines
2.7 KiB
C++
95 lines
2.7 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
#include "cmArchiveWrite.h"
|
|
#include "cmCPackGenerator.h"
|
|
|
|
class cmCPackComponent;
|
|
|
|
/** \class cmCPackArchiveGenerator
|
|
* \brief A generator base for libarchive generation.
|
|
* The generator itself uses the libarchive wrapper
|
|
* \ref cmArchiveWrite.
|
|
*
|
|
*/
|
|
class cmCPackArchiveGenerator : public cmCPackGenerator
|
|
{
|
|
public:
|
|
using Superclass = cmCPackGenerator;
|
|
|
|
static cmCPackGenerator* Create7ZGenerator();
|
|
static cmCPackGenerator* CreateTBZ2Generator();
|
|
static cmCPackGenerator* CreateTGZGenerator();
|
|
static cmCPackGenerator* CreateTXZGenerator();
|
|
static cmCPackGenerator* CreateTZGenerator();
|
|
static cmCPackGenerator* CreateTZSTGenerator();
|
|
static cmCPackGenerator* CreateZIPGenerator();
|
|
|
|
/**
|
|
* Construct generator
|
|
*/
|
|
cmCPackArchiveGenerator(cmArchiveWrite::Compress t, std::string format,
|
|
std::string extension);
|
|
~cmCPackArchiveGenerator() override;
|
|
// Used to add a header to the archive
|
|
virtual int GenerateHeader(std::ostream* os);
|
|
// component support
|
|
bool SupportsComponentInstallation() const override;
|
|
|
|
private:
|
|
// get archive component filename
|
|
std::string GetArchiveComponentFileName(const std::string& component,
|
|
bool isGroupName);
|
|
|
|
protected:
|
|
int InitializeInternal() override;
|
|
/**
|
|
* Add the files belonging to the specified component
|
|
* to the provided (already opened) archive.
|
|
* @param[in,out] archive the archive object
|
|
* @param[in] component the component whose file will be added to archive
|
|
*/
|
|
int addOneComponentToArchive(cmArchiveWrite& archive,
|
|
cmCPackComponent* component);
|
|
|
|
/**
|
|
* The main package file method.
|
|
* If component install was required this
|
|
* method will call either PackageComponents or
|
|
* PackageComponentsAllInOne.
|
|
*/
|
|
int PackageFiles() override;
|
|
/**
|
|
* The method used to package files when component
|
|
* install is used. This will create one
|
|
* archive for each component group.
|
|
*/
|
|
int PackageComponents(bool ignoreGroup);
|
|
/**
|
|
* Special case of component install where all
|
|
* components will be put in a single installer.
|
|
*/
|
|
int PackageComponentsAllInOne();
|
|
|
|
private:
|
|
const char* GetNameOfClass() override { return "cmCPackArchiveGenerator"; }
|
|
|
|
const char* GetOutputExtension() override
|
|
{
|
|
return this->OutputExtension.c_str();
|
|
}
|
|
|
|
bool SetArchiveOptions(cmArchiveWrite* archive);
|
|
|
|
private:
|
|
cmArchiveWrite::Compress Compress;
|
|
std::string ArchiveFormat;
|
|
std::string OutputExtension;
|
|
};
|