| /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying |
| file Copyright.txt or https://cmake.org/licensing for details. */ |
| |
| #include <cstddef> |
| #include <functional> |
| #include <iostream> |
| #include <map> |
| #include <memory> |
| #include <sstream> |
| #include <string> |
| #include <utility> |
| #include <vector> |
| |
| #include <cmext/algorithm> |
| |
| #include "cmsys/Encoding.hxx" |
| |
| #include "cmCPackGenerator.h" |
| #include "cmCPackGeneratorFactory.h" |
| #include "cmCPackLog.h" |
| #include "cmCommandLineArgument.h" |
| #include "cmConsoleBuf.h" |
| #include "cmDocumentation.h" |
| #include "cmDocumentationEntry.h" |
| #include "cmDocumentationFormatter.h" |
| #include "cmGlobalGenerator.h" |
| #include "cmMakefile.h" |
| #include "cmState.h" |
| #include "cmStateSnapshot.h" |
| #include "cmStringAlgorithms.h" |
| #include "cmSystemTools.h" |
| #include "cmValue.h" |
| #include "cmake.h" |
| |
| namespace { |
| const char* cmDocumentationName[][2] = { |
| { nullptr, " cpack - Packaging driver provided by CMake." }, |
| { nullptr, nullptr } |
| }; |
| |
| const char* cmDocumentationUsage[][2] = { |
| // clang-format off |
| { nullptr, " cpack [options]" }, |
| { nullptr, nullptr } |
| // clang-format on |
| }; |
| |
| const char* cmDocumentationOptions[][2] = { |
| { "-G <generators>", "Override/define CPACK_GENERATOR" }, |
| { "-C <Configuration>", "Specify the project configuration" }, |
| { "-D <var>=<value>", "Set a CPack variable." }, |
| { "--config <configFile>", "Specify the config file." }, |
| { "--verbose,-V", "Enable verbose output" }, |
| { "--trace", "Put underlying cmake scripts in trace mode." }, |
| { "--trace-expand", "Put underlying cmake scripts in expanded trace mode." }, |
| { "--debug", "Enable debug output (for CPack developers)" }, |
| { "-P <packageName>", "Override/define CPACK_PACKAGE_NAME" }, |
| { "-R <packageVersion>", "Override/define CPACK_PACKAGE_VERSION" }, |
| { "-B <packageDirectory>", "Override/define CPACK_PACKAGE_DIRECTORY" }, |
| { "--vendor <vendorName>", "Override/define CPACK_PACKAGE_VENDOR" }, |
| { nullptr, nullptr } |
| }; |
| |
| void cpackProgressCallback(const std::string& message, float /*unused*/) |
| { |
| std::cout << "-- " << message << std::endl; |
| } |
| } // namespace |
| |
| // this is CPack. |
| int main(int argc, char const* const* argv) |
| { |
| cmSystemTools::EnsureStdPipes(); |
| |
| // Replace streambuf so we can output Unicode to console |
| cmConsoleBuf consoleBuf; |
| consoleBuf.SetUTF8Pipes(); |
| |
| cmsys::Encoding::CommandLineArguments args = |
| cmsys::Encoding::CommandLineArguments::Main(argc, argv); |
| argc = args.argc(); |
| argv = args.argv(); |
| |
| std::vector<std::string> inputArgs; |
| inputArgs.reserve(argc - 1); |
| cm::append(inputArgs, argv + 1, argv + argc); |
| |
| cmSystemTools::InitializeLibUV(); |
| cmSystemTools::FindCMakeResources(argv[0]); |
| cmCPackLog log; |
| |
| log.SetErrorPrefix("CPack Error: "); |
| log.SetWarningPrefix("CPack Warning: "); |
| log.SetOutputPrefix("CPack: "); |
| log.SetVerbosePrefix("CPack Verbose: "); |
| |
| if (cmSystemTools::GetCurrentWorkingDirectory().empty()) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Current working directory cannot be established." |
| << std::endl); |
| return 1; |
| } |
| |
| std::string generator; |
| bool help = false; |
| bool helpVersion = false; |
| std::string helpFull; |
| std::string helpMAN; |
| std::string helpHTML; |
| |
| std::string cpackProjectName; |
| std::string cpackProjectDirectory; |
| std::string cpackBuildConfig; |
| std::string cpackProjectVersion; |
| std::string cpackProjectPatch; |
| std::string cpackProjectVendor; |
| std::string cpackConfigFile; |
| |
| std::map<std::string, std::string> definitions; |
| |
| auto const verboseLambda = [&log](const std::string&, cmake*, |
| cmMakefile*) -> bool { |
| log.SetVerbose(true); |
| cmCPack_Log(&log, cmCPackLog::LOG_OUTPUT, "Enable Verbose" << std::endl); |
| return true; |
| }; |
| |
| auto const debugLambda = [&log](const std::string&, cmake*, |
| cmMakefile*) -> bool { |
| log.SetDebug(true); |
| cmCPack_Log(&log, cmCPackLog::LOG_OUTPUT, "Enable Debug" << std::endl); |
| return true; |
| }; |
| |
| auto const traceLambda = [](const std::string&, cmake* state, |
| cmMakefile*) -> bool { |
| state->SetTrace(true); |
| return true; |
| }; |
| |
| auto const traceExpandLambda = [](const std::string&, cmake* state, |
| cmMakefile*) -> bool { |
| state->SetTrace(true); |
| state->SetTraceExpand(true); |
| return true; |
| }; |
| |
| using CommandArgument = |
| cmCommandLineArgument<bool(std::string const&, cmake*, cmMakefile*)>; |
| |
| std::vector<CommandArgument> arguments = { |
| CommandArgument{ "--help", CommandArgument::Values::Zero, |
| CommandArgument::setToTrue(help) }, |
| CommandArgument{ "--help-full", CommandArgument::Values::Zero, |
| CommandArgument::setToValue(helpFull) }, |
| CommandArgument{ "--help-html", CommandArgument::Values::Zero, |
| CommandArgument::setToValue(helpHTML) }, |
| CommandArgument{ "--help-man", CommandArgument::Values::Zero, |
| CommandArgument::setToValue(helpMAN) }, |
| CommandArgument{ "--version", CommandArgument::Values::Zero, |
| CommandArgument::setToTrue(helpVersion) }, |
| CommandArgument{ "-V", CommandArgument::Values::Zero, verboseLambda }, |
| CommandArgument{ "--verbose", CommandArgument::Values::Zero, |
| verboseLambda }, |
| CommandArgument{ "--debug", CommandArgument::Values::Zero, debugLambda }, |
| CommandArgument{ "--config", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackConfigFile) }, |
| CommandArgument{ "--trace", CommandArgument::Values::One, traceLambda }, |
| CommandArgument{ "--trace-expand", CommandArgument::Values::One, |
| traceExpandLambda }, |
| CommandArgument{ "-C", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackBuildConfig) }, |
| CommandArgument{ "-G", CommandArgument::Values::One, |
| CommandArgument::setToValue(generator) }, |
| CommandArgument{ "-P", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackProjectName) }, |
| CommandArgument{ "-R", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackProjectVersion) }, |
| CommandArgument{ "-B", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackProjectDirectory) }, |
| CommandArgument{ "--patch", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackProjectPatch) }, |
| CommandArgument{ "--vendor", CommandArgument::Values::One, |
| CommandArgument::setToValue(cpackProjectVendor) }, |
| CommandArgument{ |
| "-D", CommandArgument::Values::One, |
| [&log, &definitions](const std::string& arg, cmake*, |
| cmMakefile*) -> bool { |
| std::string value = arg; |
| size_t pos = value.find_first_of('='); |
| if (pos == std::string::npos) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Please specify CPack definitions as: KEY=VALUE" |
| << std::endl); |
| return false; |
| } |
| std::string key = value.substr(0, pos); |
| value.erase(0, pos + 1); |
| definitions[key] = value; |
| cmCPack_Log(&log, cmCPackLog::LOG_DEBUG, |
| "Set CPack variable: " << key << " to \"" << value << "\"" |
| << std::endl); |
| return true; |
| } }, |
| }; |
| |
| cmake cminst(cmake::RoleScript, cmState::CPack); |
| cminst.SetHomeDirectory(""); |
| cminst.SetHomeOutputDirectory(""); |
| cminst.SetProgressCallback(cpackProgressCallback); |
| cminst.GetCurrentSnapshot().SetDefaultDefinitions(); |
| cmGlobalGenerator cmgg(&cminst); |
| cmMakefile globalMF(&cmgg, cminst.GetCurrentSnapshot()); |
| #if defined(__CYGWIN__) |
| globalMF.AddDefinition("CMAKE_LEGACY_CYGWIN_WIN32", "0"); |
| #endif |
| |
| bool parsed = true; |
| for (std::size_t i = 0; i < inputArgs.size(); i++) { |
| auto const& arg = inputArgs[i]; |
| for (auto const& m : arguments) { |
| if (m.matches(arg)) { |
| if (!m.parse(arg, i, inputArgs, &cminst, &globalMF)) { |
| parsed = false; |
| } |
| break; |
| } |
| } |
| } |
| |
| cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE, |
| "Read CPack config file: " << cpackConfigFile << std::endl); |
| |
| bool cpackConfigFileSpecified = true; |
| if (cpackConfigFile.empty()) { |
| cpackConfigFile = cmStrCat(cmSystemTools::GetCurrentWorkingDirectory(), |
| "/CPackConfig.cmake"); |
| cpackConfigFileSpecified = false; |
| } |
| |
| cmCPackGeneratorFactory generators; |
| generators.SetLogger(&log); |
| |
| 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; |
| |
| // 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)) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Error reading CMakeDetermineSystem.cmake" << std::endl); |
| return 1; |
| } |
| |
| systemFile = |
| globalMF.GetModulesFile("CMakeSystemSpecificInformation.cmake"); |
| if (!globalMF.ReadListFile(systemFile)) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Error reading CMakeSystemSpecificInformation.cmake" |
| << std::endl); |
| return 1; |
| } |
| |
| if (!cpackBuildConfig.empty()) { |
| globalMF.AddDefinition("CPACK_BUILD_CONFIG", cpackBuildConfig); |
| } |
| |
| if (cmSystemTools::FileExists(cpackConfigFile)) { |
| cpackConfigFile = cmSystemTools::CollapseFullPath(cpackConfigFile); |
| cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE, |
| "Read CPack configuration file: " << cpackConfigFile |
| << std::endl); |
| if (!globalMF.ReadListFile(cpackConfigFile)) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Problem reading CPack config file: \"" |
| << cpackConfigFile << "\"" << std::endl); |
| 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); |
| } |
| if (!cpackProjectName.empty()) { |
| globalMF.AddDefinition("CPACK_PACKAGE_NAME", cpackProjectName); |
| } |
| if (!cpackProjectVersion.empty()) { |
| globalMF.AddDefinition("CPACK_PACKAGE_VERSION", cpackProjectVersion); |
| } |
| if (!cpackProjectVendor.empty()) { |
| globalMF.AddDefinition("CPACK_PACKAGE_VENDOR", cpackProjectVendor); |
| } |
| // 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); |
| } |
| // The value has not been set on the command line |
| else { |
| // get a default value (current working directory) |
| cpackProjectDirectory = cmSystemTools::GetCurrentWorkingDirectory(); |
| // use default value if no value has been provided by the config file |
| if (!globalMF.IsSet("CPACK_PACKAGE_DIRECTORY")) { |
| globalMF.AddDefinition("CPACK_PACKAGE_DIRECTORY", |
| cpackProjectDirectory); |
| } |
| } |
| for (auto const& cd : definitions) { |
| globalMF.AddDefinition(cd.first, cd.second); |
| } |
| |
| // Force CPACK_PACKAGE_DIRECTORY as absolute path |
| cpackProjectDirectory = |
| globalMF.GetSafeDefinition("CPACK_PACKAGE_DIRECTORY"); |
| cpackProjectDirectory = |
| cmSystemTools::CollapseFullPath(cpackProjectDirectory); |
| globalMF.AddDefinition("CPACK_PACKAGE_DIRECTORY", cpackProjectDirectory); |
| |
| cmValue cpackModulesPath = globalMF.GetDefinition("CPACK_MODULE_PATH"); |
| if (cpackModulesPath) { |
| globalMF.AddDefinition("CMAKE_MODULE_PATH", *cpackModulesPath); |
| } |
| cmValue genList = globalMF.GetDefinition("CPACK_GENERATOR"); |
| if (!genList) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "CPack generator not specified" << std::endl); |
| } else { |
| std::vector<std::string> generatorsVector = cmExpandedList(*genList); |
| for (std::string const& gen : generatorsVector) { |
| cmMakefile::ScopePushPop raii(&globalMF); |
| cmMakefile* mf = &globalMF; |
| cmCPack_Log(&log, cmCPackLog::LOG_VERBOSE, |
| "Specified generator: " << gen << std::endl); |
| if (!mf->GetDefinition("CPACK_PACKAGE_NAME")) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "CPack project name not specified" << std::endl); |
| parsed = false; |
| } |
| 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 = false; |
| } |
| if (parsed) { |
| std::unique_ptr<cmCPackGenerator> cpackGenerator = |
| generators.NewGenerator(gen); |
| if (cpackGenerator) { |
| cpackGenerator->SetTrace(cminst.GetTrace()); |
| cpackGenerator->SetTraceExpand(cminst.GetTraceExpand()); |
| } else { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Could not create CPack generator: " << gen |
| << std::endl); |
| // Print out all the valid generators |
| cmDocumentation generatorDocs; |
| std::vector<cmDocumentationEntry> v; |
| for (auto const& g : generators.GetGeneratorsList()) { |
| cmDocumentationEntry e; |
| e.Name = g.first; |
| e.Brief = g.second; |
| v.push_back(std::move(e)); |
| } |
| generatorDocs.SetSection("Generators", v); |
| std::cerr << "\n"; |
| generatorDocs.PrintDocumentation(cmDocumentation::ListGenerators, |
| std::cerr); |
| parsed = false; |
| } |
| |
| if (parsed && !cpackGenerator->Initialize(gen, mf)) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Cannot initialize the generator " << gen |
| << std::endl); |
| parsed = false; |
| } |
| |
| if (!mf->GetDefinition("CPACK_INSTALL_COMMANDS") && |
| !mf->GetDefinition("CPACK_INSTALL_SCRIPT") && |
| !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, CPACK_INSTALL_SCRIPT, or " |
| "CPACK_INSTALLED_DIRECTORIES." |
| << std::endl); |
| parsed = false; |
| } |
| if (parsed) { |
| cmValue 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); |
| |
| cmValue projVersion = mf->GetDefinition("CPACK_PACKAGE_VERSION"); |
| if (!projVersion) { |
| cmValue projVersionMajor = |
| mf->GetDefinition("CPACK_PACKAGE_VERSION_MAJOR"); |
| cmValue projVersionMinor = |
| mf->GetDefinition("CPACK_PACKAGE_VERSION_MINOR"); |
| cmValue projVersionPatch = |
| mf->GetDefinition("CPACK_PACKAGE_VERSION_PATCH"); |
| std::ostringstream ostr; |
| ostr << *projVersionMajor << "." << *projVersionMinor << "." |
| << *projVersionPatch; |
| mf->AddDefinition("CPACK_PACKAGE_VERSION", ostr.str()); |
| } |
| |
| int res = cpackGenerator->DoPackage(); |
| if (!res) { |
| cmCPack_Log(&log, cmCPackLog::LOG_ERROR, |
| "Error when generating package: " << *projName |
| << std::endl); |
| return 1; |
| } |
| } |
| } |
| } |
| } |
| } |
| |
| /* 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) { |
| // Construct and print requested documentation. |
| |
| doc.SetName("cpack"); |
| doc.SetSection("Name", cmDocumentationName); |
| doc.SetSection("Usage", cmDocumentationUsage); |
| doc.PrependSection("Options", cmDocumentationOptions); |
| |
| std::vector<cmDocumentationEntry> v; |
| for (auto const& g : generators.GetGeneratorsList()) { |
| cmDocumentationEntry e; |
| e.Name = g.first; |
| e.Brief = g.second; |
| v.push_back(std::move(e)); |
| } |
| doc.SetSection("Generators", v); |
| |
| return doc.PrintRequestedDocumentation(std::cout) ? 0 : 1; |
| } |
| |
| if (cmSystemTools::GetErrorOccuredFlag()) { |
| return 1; |
| } |
| |
| return 0; |
| } |
