CMake/Source/cmInstallFilesCommand.cxx

146 lines
4.6 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. */
2001-05-23 19:31:43 +04:00
#include "cmInstallFilesCommand.h"
#include "cmInstallFilesGenerator.h"
2001-05-23 19:31:43 +04:00
// cmExecutableCommand
bool cmInstallFilesCommand::InitialPass(std::vector<std::string> const& args,
cmExecutionStatus&)
2001-05-23 19:31:43 +04:00
{
if (args.size() < 2) {
2001-05-23 19:31:43 +04:00
this->SetError("called with incorrect number of arguments");
return false;
}
// Enable the install target.
this->Makefile->GetGlobalGenerator()->EnableInstallTarget();
this->Destination = args[0];
if ((args.size() > 1) && (args[1] == "FILES")) {
2012-05-13 17:34:30 +04:00
this->IsFilesForm = true;
for (std::vector<std::string>::const_iterator s = args.begin() + 2;
s != args.end(); ++s) {
// Find the source location for each file listed.
std::string f = this->FindInstallSource(s->c_str());
this->Files.push_back(f);
}
this->CreateInstallGenerator();
} else {
2006-03-15 19:02:08 +03:00
this->IsFilesForm = false;
this->FinalArgs.insert(this->FinalArgs.end(), args.begin() + 1,
args.end());
}
2012-05-13 17:34:30 +04:00
this->Makefile->GetGlobalGenerator()->AddInstallComponent(
this->Makefile->GetSafeDefinition("CMAKE_INSTALL_DEFAULT_COMPONENT_NAME"));
ENH: Further refinement of the CPack components functionality from Doug Gregor. Details: ========== - New cpack_add_component, cpack_add_component_group, and cpack_add_install_type "commands" defined as macros in the CPack module. - Documentation for all of the variables and commands in the CPack module. - Added get_cmake_property(... COMPONENTS) to CMake to ask for the names of all components. Used in the CPack module to automatically build component-based installers. (Set CPACK_MONOLITHIC_INSTALL to turn off component-based installation). - A group can declare its PARENT_GROUP, to build an arbitrary hierarchy of groups. - New CPack command cpack_configure_downloads, which creates an installer that downloads only the selected components on-the-fly. Those components marked DOWNLOADED will be separate packages downloaded on-the-fly (or, all packages can be marked as such with the ALL option to cpack_configure_downloads). Individual components are compressed with ZIP at installer-creation time and downloaded/uncompressed by the installer as needed. This feature is only available on Windows with NSIS at the moment. - NSIS installers can install themselves and enable the "Change" button in Add/Remove programs, allowing users to go back and install or remove components. This can be disabled through cpack_configure_downloads, because it's only really useful is most of the application's functionality is in downloaded components. - Bug fix: automatically install everything whose COMPONENT was not specified (it's a hidden, required group) - Bug fix: fixed removal of components when re-running the NSIS installer and unchecking components - Bug fix: NSIS installers now only install/remove the minimal number of files when re-run to update the installation (or by clicking "Change" in Add/Remove programs)
2008-07-08 19:52:25 +04:00
2001-05-23 19:31:43 +04:00
return true;
}
2012-05-13 17:34:30 +04:00
void cmInstallFilesCommand::FinalPass()
2001-05-23 19:31:43 +04:00
{
// No final pass for "FILES" form of arguments.
if (this->IsFilesForm) {
return;
}
2012-05-13 17:34:30 +04:00
2001-05-23 19:31:43 +04:00
std::string testf;
2006-03-15 19:02:08 +03:00
std::string ext = this->FinalArgs[0];
2012-05-13 17:34:30 +04:00
2001-06-21 20:01:18 +04:00
// two different options
if (this->FinalArgs.size() > 1) {
2001-05-23 19:31:43 +04:00
// now put the files into the list
2006-03-15 19:02:08 +03:00
std::vector<std::string>::iterator s = this->FinalArgs.begin();
2001-05-23 19:31:43 +04:00
++s;
2012-05-13 17:34:30 +04:00
// for each argument, get the files
for (; s != this->FinalArgs.end(); ++s) {
2001-05-23 19:31:43 +04:00
// replace any variables
std::string temps = *s;
if (!cmSystemTools::GetFilenamePath(temps).empty()) {
testf = cmSystemTools::GetFilenamePath(temps) + "/" +
cmSystemTools::GetFilenameWithoutLastExtension(temps) + ext;
} else {
testf = cmSystemTools::GetFilenameWithoutLastExtension(temps) + ext;
}
2012-05-13 17:34:30 +04:00
// add to the result
this->Files.push_back(this->FindInstallSource(testf.c_str()));
2001-06-21 20:01:18 +04:00
}
} else // reg exp list
{
2001-06-21 20:01:18 +04:00
std::vector<std::string> files;
std::string regex = this->FinalArgs[0];
cmSystemTools::Glob(this->Makefile->GetCurrentSourceDirectory(), regex,
files);
2012-05-13 17:34:30 +04:00
2001-06-21 20:01:18 +04:00
std::vector<std::string>::iterator s = files.begin();
2012-05-13 17:34:30 +04:00
// for each argument, get the files
for (; s != files.end(); ++s) {
this->Files.push_back(this->FindInstallSource(s->c_str()));
2001-05-23 19:31:43 +04:00
}
}
this->CreateInstallGenerator();
}
void cmInstallFilesCommand::CreateInstallGenerator() const
{
// Construct the destination. This command always installs under
// the prefix. We skip the leading slash given by the user.
std::string destination = this->Destination.substr(1);
cmSystemTools::ConvertToUnixSlashes(destination);
if (destination.empty()) {
destination = ".";
}
// Use a file install generator.
const char* no_permissions = "";
const char* no_rename = "";
bool no_exclude_from_all = false;
std::string no_component =
this->Makefile->GetSafeDefinition("CMAKE_INSTALL_DEFAULT_COMPONENT_NAME");
std::vector<std::string> no_configurations;
cmInstallGenerator::MessageLevel message =
cmInstallGenerator::SelectMessageLevel(this->Makefile);
this->Makefile->AddInstallGenerator(new cmInstallFilesGenerator(
this->Files, destination.c_str(), false, no_permissions, no_configurations,
no_component.c_str(), message, no_exclude_from_all, no_rename));
2001-05-23 19:31:43 +04:00
}
2001-06-21 20:01:18 +04:00
/**
* Find a file in the build or source tree for installation given a
* relative path from the CMakeLists.txt file. This will favor files
* present in the build tree. If a full path is given, it is just
* returned.
*/
std::string cmInstallFilesCommand::FindInstallSource(const char* name) const
{
if (cmSystemTools::FileIsFullPath(name) ||
cmGeneratorExpression::Find(name) == 0) {
// This is a full path.
return name;
}
2012-05-13 17:34:30 +04:00
// This is a relative path.
std::string tb = this->Makefile->GetCurrentBinaryDirectory();
tb += "/";
tb += name;
std::string ts = this->Makefile->GetCurrentSourceDirectory();
ts += "/";
ts += name;
2012-05-13 17:34:30 +04:00
if (cmSystemTools::FileExists(tb.c_str())) {
// The file exists in the binary tree. Use it.
return tb;
2016-09-16 23:45:24 +03:00
}
if (cmSystemTools::FileExists(ts.c_str())) {
// The file exists in the source tree. Use it.
return ts;
}
2016-09-16 23:45:24 +03:00
// The file doesn't exist. Assume it will be present in the
// binary tree when the install occurs.
return tb;
}