CMake/Source/CPack/cpack.cxx

429 lines
16 KiB
C++
Raw Normal View History

Simplify CMake per-source license notices 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.
2016-09-27 22:01:08 +03:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
2016-09-07 01:21:35 +03:00
#include <cmConfigure.h>
2006-01-02 07:21:05 +03:00
2007-11-06 00:55:45 +03:00
#include "cmCPackGenerator.h"
#include "cmCPackGeneratorFactory.h"
2016-09-07 01:21:35 +03:00
#include "cmCPackLog.h"
#include "cmDocumentation.h"
2016-09-07 01:21:35 +03:00
#include "cmDocumentationEntry.h"
#include "cmGlobalGenerator.h"
#include "cmMakefile.h"
2016-09-07 01:21:35 +03:00
#include "cmState.h"
#include "cmSystemTools.h"
#include "cmTypeMacro.h"
#include "cm_auto_ptr.hxx"
#include "cmake.h"
2006-01-03 00:14:21 +03:00
2006-01-02 07:21:05 +03:00
#include <cmsys/CommandLineArguments.hxx>
#include <cmsys/Encoding.hxx>
2016-09-07 01:21:35 +03:00
#include <iostream>
#include <map>
#include <sstream>
#include <stddef.h>
#include <string>
#include <utility>
#include <vector>
2006-01-02 07:21:05 +03:00
static const char* cmDocumentationName[][2] = {
2016-06-27 23:44:16 +03:00
{ CM_NULLPTR, " cpack - Packaging driver provided by CMake." },
{ CM_NULLPTR, CM_NULLPTR }
2006-01-02 07:21:05 +03:00
};
static const char* cmDocumentationUsage[][2] = {
2016-06-27 23:44:16 +03:00
{ CM_NULLPTR, " cpack -G <generator> [options]" },
{ CM_NULLPTR, CM_NULLPTR }
2006-01-02 07:21:05 +03:00
};
static const char* cmDocumentationOptions[][2] = {
{ "-G <generator>", "Use the specified generator to generate package." },
{ "-C <Configuration>", "Specify the project configuration" },
{ "-D <var>=<value>", "Set a CPack variable." },
{ "--config <config file>", "Specify the config file." },
{ "--verbose,-V", "enable verbose output" },
{ "--debug", "enable debug output (for CPack developers)" },
{ "-P <package name>", "override/define CPACK_PACKAGE_NAME" },
{ "-R <package version>", "override/define CPACK_PACKAGE_VERSION" },
{ "-B <package directory>", "override/define CPACK_PACKAGE_DIRECTORY" },
{ "--vendor <vendor name>", "override/define CPACK_PACKAGE_VENDOR" },
2016-06-27 23:44:16 +03:00
{ CM_NULLPTR, CM_NULLPTR }
2006-01-02 07:21:05 +03:00
};
int cpackUnknownArgument(const char* /*unused*/, void* /*unused*/)
2006-01-02 07:21:05 +03:00
{
return 1;
}
2006-01-03 00:14:21 +03:00
struct cpackDefinitions
{
typedef std::map<std::string, std::string> MapType;
2006-03-10 21:06:26 +03:00
MapType Map;
cmCPackLog* Log;
2006-01-03 00:14:21 +03:00
};
2006-01-02 07:21:05 +03:00
2006-03-10 21:06:26 +03:00
int cpackDefinitionArgument(const char* argument, const char* cValue,
void* call_data)
2006-01-02 07:21:05 +03:00
{
(void)argument;
2006-01-03 00:14:21 +03:00
cpackDefinitions* def = static_cast<cpackDefinitions*>(call_data);
2006-01-02 07:21:05 +03:00
std::string value = cValue;
size_t pos = value.find_first_of('=');
if (pos == std::string::npos) {
2006-03-10 21:06:26 +03:00
cmCPack_Log(def->Log, cmCPackLog::LOG_ERROR,
"Please specify CPack definitions as: KEY=VALUE" << std::endl);
2006-01-02 07:21:05 +03:00
return 0;
}
2006-01-02 07:21:05 +03:00
std::string key = value.substr(0, pos);
value = value.c_str() + pos + 1;
2006-03-10 21:06:26 +03:00
def->Map[key] = value;
cmCPack_Log(def->Log, cmCPackLog::LOG_DEBUG, "Set CPack variable: "
<< key << " to \"" << value << "\"" << std::endl);
2006-01-02 07:21:05 +03:00
return 1;
}
// this is CPack.
int main(int argc, char const* const* argv)
2006-01-02 07:21:05 +03:00
{
cmsys::Encoding::CommandLineArguments args =
cmsys::Encoding::CommandLineArguments::Main(argc, argv);
argc = args.argc();
argv = args.argv();
cmSystemTools::FindCMakeResources(argv[0]);
2006-01-03 00:14:21 +03:00
cmCPackLog log;
2006-01-03 00:14:21 +03:00
log.SetErrorPrefix("CPack Error: ");
log.SetWarningPrefix("CPack Warning: ");
log.SetOutputPrefix("CPack: ");
log.SetVerbosePrefix("CPack Verbose: ");
2006-01-03 00:14:21 +03:00
2006-01-02 07:21:05 +03:00
cmSystemTools::EnableMSVCDebugHook();
if (cmSystemTools::GetCurrentWorkingDirectory().empty()) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Current working directory cannot be established."
<< std::endl);
return 1;
}
2006-01-02 07:21:05 +03:00
std::string generator;
bool help = false;
bool helpVersion = false;
2006-01-03 00:14:21 +03:00
bool verbose = false;
bool debug = false;
2006-01-02 07:21:05 +03:00
std::string helpFull;
std::string helpMAN;
std::string helpHTML;
std::string cpackProjectName;
std::string cpackProjectDirectory;
2006-01-02 07:21:05 +03:00
std::string cpackBuildConfig;
std::string cpackProjectVersion;
std::string cpackProjectPatch;
std::string cpackProjectVendor;
2006-01-03 00:14:21 +03:00
std::string cpackConfigFile;
cpackDefinitions definitions;
2006-03-10 21:06:26 +03:00
definitions.Log = &log;
2006-01-03 00:14:21 +03:00
cpackConfigFile = "";
2006-01-02 07:21:05 +03:00
cmsys::CommandLineArguments arg;
arg.Initialize(argc, argv);
typedef cmsys::CommandLineArguments argT;
// Help arguments
arg.AddArgument("--help", argT::NO_ARGUMENT, &help, "CPack help");
2006-03-09 16:32:08 +03:00
arg.AddArgument("--help-full", argT::SPACE_ARGUMENT, &helpFull,
"CPack help");
2006-03-09 16:32:08 +03:00
arg.AddArgument("--help-html", argT::SPACE_ARGUMENT, &helpHTML,
"CPack help");
2006-01-02 07:21:05 +03:00
arg.AddArgument("--help-man", argT::SPACE_ARGUMENT, &helpMAN, "CPack help");
arg.AddArgument("--version", argT::NO_ARGUMENT, &helpVersion, "CPack help");
2006-01-03 00:14:21 +03:00
arg.AddArgument("-V", argT::NO_ARGUMENT, &verbose, "CPack verbose");
arg.AddArgument("--verbose", argT::NO_ARGUMENT, &verbose, "-V");
arg.AddArgument("--debug", argT::NO_ARGUMENT, &debug, "-V");
arg.AddArgument("--config", argT::SPACE_ARGUMENT, &cpackConfigFile,
"CPack configuration file");
arg.AddArgument("-C", argT::SPACE_ARGUMENT, &cpackBuildConfig,
"CPack build configuration");
arg.AddArgument("-G", argT::SPACE_ARGUMENT, &generator, "CPack generator");
arg.AddArgument("-P", argT::SPACE_ARGUMENT, &cpackProjectName,
"CPack project name");
arg.AddArgument("-R", argT::SPACE_ARGUMENT, &cpackProjectVersion,
"CPack project version");
arg.AddArgument("-B", argT::SPACE_ARGUMENT, &cpackProjectDirectory,
"CPack project directory");
arg.AddArgument("--patch", argT::SPACE_ARGUMENT, &cpackProjectPatch,
"CPack project patch");
arg.AddArgument("--vendor", argT::SPACE_ARGUMENT, &cpackProjectVendor,
"CPack project vendor");
arg.AddCallback("-D", argT::SPACE_ARGUMENT, cpackDefinitionArgument,
&definitions, "CPack Definitions");
2006-01-02 07:21:05 +03:00
arg.SetUnknownArgumentCallback(cpackUnknownArgument);
2006-01-03 00:14:21 +03:00
// Parse command line
2006-01-02 07:21:05 +03:00
int parsed = arg.Parse();
2006-01-03 00:14:21 +03:00
// Setup logging
if (verbose) {
2006-01-03 00:14:21 +03:00
log.SetVerbose(verbose);
cmCPack_Log(&log, cmCPackLog::LOG_OUTPUT, "Enable Verbose" << std::endl);
}
if (debug) {
2006-01-03 00:14:21 +03:00
log.SetDebug(debug);
cmCPack_Log(&log, cmCPackLog::LOG_OUTPUT, "Enable Debug" << std::endl);
}
2006-01-03 00:14:21 +03:00
cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE,
"Read CPack config file: " << cpackConfigFile << std::endl);
2006-01-03 00:14:21 +03:00
cmake cminst;
cminst.SetHomeDirectory("");
cminst.SetHomeOutputDirectory("");
cminst.GetCurrentSnapshot().SetDefaultDefinitions();
2015-04-11 13:52:14 +03:00
cminst.GetState()->RemoveUnscriptableCommands();
cmGlobalGenerator cmgg(&cminst);
CM_AUTO_PTR<cmMakefile> globalMF(
new cmMakefile(&cmgg, cminst.GetCurrentSnapshot()));
#if defined(__CYGWIN__)
globalMF->AddDefinition("CMAKE_LEGACY_CYGWIN_WIN32", "0");
#endif
bool cpackConfigFileSpecified = true;
if (cpackConfigFile.empty()) {
cpackConfigFile = cmSystemTools::GetCurrentWorkingDirectory();
cpackConfigFile += "/CPackConfig.cmake";
cpackConfigFileSpecified = false;
}
2006-01-03 00:14:21 +03:00
2007-11-06 00:33:19 +03:00
cmCPackGeneratorFactory generators;
2006-01-03 00:14:21 +03:00
generators.SetLogger(&log);
2016-06-27 23:44:16 +03:00
cmCPackGenerator* cpackGenerator = CM_NULLPTR;
2006-01-02 07:21:05 +03:00
cmDocumentation doc;
doc.addCPackStandardDocSections();
/* Were we invoked to display doc or to do some work ?
* Unlike cmake launching cpack with zero argument
* should launch cpack using "cpackConfigFile" if it exists
* in the current directory.
*/
help = doc.CheckOptions(argc, argv, "-G") && argc != 1;
2006-01-02 07:21:05 +03:00
// This part is used for cpack documentation lookup as well.
cminst.AddCMakePaths();
if (parsed && !help) {
// find out which system cpack is running on, so it can setup the search
// paths, so FIND_XXX() commands can be used in scripts
std::string systemFile =
globalMF->GetModulesFile("CMakeDetermineSystem.cmake");
if (!globalMF->ReadListFile(systemFile.c_str())) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Error reading CMakeDetermineSystem.cmake" << std::endl);
return 1;
}
systemFile =
globalMF->GetModulesFile("CMakeSystemSpecificInformation.cmake");
if (!globalMF->ReadListFile(systemFile.c_str())) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Error reading CMakeSystemSpecificInformation.cmake"
<< std::endl);
return 1;
}
if (!cpackBuildConfig.empty()) {
globalMF->AddDefinition("CPACK_BUILD_CONFIG", cpackBuildConfig.c_str());
}
if (cmSystemTools::FileExists(cpackConfigFile.c_str())) {
cpackConfigFile = cmSystemTools::CollapseFullPath(cpackConfigFile);
cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE,
"Read CPack configuration file: " << cpackConfigFile
<< std::endl);
if (!globalMF->ReadListFile(cpackConfigFile.c_str())) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Problem reading CPack config file: \""
<< cpackConfigFile << "\"" << std::endl);
2006-02-23 17:59:42 +03:00
return 1;
}
} else if (cpackConfigFileSpecified) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Cannot find CPack config file: \"" << cpackConfigFile
<< "\"" << std::endl);
return 1;
}
if (!generator.empty()) {
globalMF->AddDefinition("CPACK_GENERATOR", generator.c_str());
}
if (!cpackProjectName.empty()) {
globalMF->AddDefinition("CPACK_PACKAGE_NAME", cpackProjectName.c_str());
}
if (!cpackProjectVersion.empty()) {
2006-07-10 15:52:35 +04:00
globalMF->AddDefinition("CPACK_PACKAGE_VERSION",
cpackProjectVersion.c_str());
}
if (!cpackProjectVendor.empty()) {
2006-07-10 15:52:35 +04:00
globalMF->AddDefinition("CPACK_PACKAGE_VENDOR",
cpackProjectVendor.c_str());
}
// if this is not empty it has been set on the command line
// go for it. Command line override values set in config file.
if (!cpackProjectDirectory.empty()) {
globalMF->AddDefinition("CPACK_PACKAGE_DIRECTORY",
cpackProjectDirectory.c_str());
}
// The value has not been set on the command line
else {
// get a default value (current working directory)
cpackProjectDirectory = cmsys::SystemTools::GetCurrentWorkingDirectory();
// use default value iff no value has been provided by the config file
if (!globalMF->IsSet("CPACK_PACKAGE_DIRECTORY")) {
globalMF->AddDefinition("CPACK_PACKAGE_DIRECTORY",
cpackProjectDirectory.c_str());
}
}
cpackDefinitions::MapType::iterator cdit;
for (cdit = definitions.Map.begin(); cdit != definitions.Map.end();
++cdit) {
globalMF->AddDefinition(cdit->first, cdit->second.c_str());
}
2006-10-17 17:34:07 +04:00
const char* cpackModulesPath =
globalMF->GetDefinition("CPACK_MODULE_PATH");
if (cpackModulesPath) {
globalMF->AddDefinition("CMAKE_MODULE_PATH", cpackModulesPath);
}
const char* genList = globalMF->GetDefinition("CPACK_GENERATOR");
if (!genList) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR, "CPack generator not specified"
<< std::endl);
} else {
2006-07-27 19:55:34 +04:00
std::vector<std::string> generatorsVector;
cmSystemTools::ExpandListArgument(genList, generatorsVector);
2006-07-27 19:55:34 +04:00
std::vector<std::string>::iterator it;
for (it = generatorsVector.begin(); it != generatorsVector.end(); ++it) {
2006-07-27 19:55:34 +04:00
const char* gen = it->c_str();
cmMakefile::ScopePushPop raii(globalMF.get());
cmMakefile* mf = globalMF.get();
cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE,
"Specified generator: " << gen << std::endl);
if (parsed && !mf->GetDefinition("CPACK_PACKAGE_NAME")) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"CPack project name not specified" << std::endl);
parsed = 0;
}
if (parsed &&
!(mf->GetDefinition("CPACK_PACKAGE_VERSION") ||
(mf->GetDefinition("CPACK_PACKAGE_VERSION_MAJOR") &&
mf->GetDefinition("CPACK_PACKAGE_VERSION_MINOR") &&
mf->GetDefinition("CPACK_PACKAGE_VERSION_PATCH")))) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"CPack project version not specified"
<< std::endl
<< "Specify CPACK_PACKAGE_VERSION, or "
"CPACK_PACKAGE_VERSION_MAJOR, "
"CPACK_PACKAGE_VERSION_MINOR, and "
"CPACK_PACKAGE_VERSION_PATCH."
<< std::endl);
parsed = 0;
}
if (parsed) {
cpackGenerator = generators.NewGenerator(gen);
if (!cpackGenerator) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Cannot initialize CPack generator: " << gen
<< std::endl);
parsed = 0;
}
if (parsed && !cpackGenerator->Initialize(gen, mf)) {
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Cannot initialize the generator " << gen
<< std::endl);
parsed = 0;
}
if (!mf->GetDefinition("CPACK_INSTALL_COMMANDS") &&
!mf->GetDefinition("CPACK_INSTALLED_DIRECTORIES") &&
!mf->GetDefinition("CPACK_INSTALL_CMAKE_PROJECTS")) {
cmCPack_Log(
&log, cmCPackLog::LOG_ERROR,
"Please specify build tree of the project that uses CMake "
"using CPACK_INSTALL_CMAKE_PROJECTS, specify "
"CPACK_INSTALL_COMMANDS, or specify "
"CPACK_INSTALLED_DIRECTORIES."
<< std::endl);
parsed = 0;
}
if (parsed) {
const char* projName = mf->GetDefinition("CPACK_PACKAGE_NAME");
cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE, "Use generator: "
<< cpackGenerator->GetNameOfClass() << std::endl);
cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE,
"For project: " << projName << std::endl);
2011-10-13 21:51:18 +04:00
const char* projVersion =
mf->GetDefinition("CPACK_PACKAGE_VERSION");
if (!projVersion) {
const char* projVersionMajor =
mf->GetDefinition("CPACK_PACKAGE_VERSION_MAJOR");
const char* projVersionMinor =
mf->GetDefinition("CPACK_PACKAGE_VERSION_MINOR");
const char* projVersionPatch =
mf->GetDefinition("CPACK_PACKAGE_VERSION_PATCH");
std::ostringstream ostr;
ostr << projVersionMajor << "." << projVersionMinor << "."
<< projVersionPatch;
mf->AddDefinition("CPACK_PACKAGE_VERSION", ostr.str().c_str());
}
2006-07-27 19:55:34 +04:00
int res = cpackGenerator->DoPackage();
if (!res) {
2006-07-27 19:55:34 +04:00
cmCPack_Log(&log, cmCPackLog::LOG_ERROR,
"Error when generating package: " << projName
<< std::endl);
return 1;
}
}
2006-01-02 07:21:05 +03:00
}
2006-07-27 19:55:34 +04:00
}
}
}
2006-01-02 07:21:05 +03:00
/* In this case we are building the documentation object
* instance in order to create appropriate structure
* in order to satisfy the appropriate --help-xxx request
*/
if (help) {
2006-07-27 19:55:34 +04:00
// Construct and print requested documentation.
2006-07-27 19:55:34 +04:00
doc.SetName("cpack");
doc.SetSection("Name", cmDocumentationName);
doc.SetSection("Usage", cmDocumentationUsage);
doc.PrependSection("Options", cmDocumentationOptions);
2006-07-27 19:55:34 +04:00
std::vector<cmDocumentationEntry> v;
2007-11-06 00:33:19 +03:00
cmCPackGeneratorFactory::DescriptionsMap::const_iterator generatorIt;
for (generatorIt = generators.GetGeneratorsList().begin();
generatorIt != generators.GetGeneratorsList().end(); ++generatorIt) {
2006-07-27 19:55:34 +04:00
cmDocumentationEntry e;
e.Name = generatorIt->first;
e.Brief = generatorIt->second;
2006-07-27 19:55:34 +04:00
v.push_back(e);
}
doc.SetSection("Generators", v);
2006-01-03 00:14:21 +03:00
#undef cout
return doc.PrintRequestedDocumentation(std::cout) ? 0 : 1;
2006-01-03 00:14:21 +03:00
#define cout no_cout_use_cmCPack_Log
}
2006-01-02 07:21:05 +03:00
if (cmSystemTools::GetErrorOccuredFlag()) {
return 1;
}
2006-01-02 07:21:05 +03:00
return 0;
}