CMake/Source/cmUtilitySourceCommand.cxx

115 lines
4.1 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 19:01:08 +00:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#include "cmUtilitySourceCommand.h"
#include <string.h>
#include "cmMakefile.h"
#include "cmState.h"
2016-10-25 18:35:04 +00:00
#include "cmStateTypes.h"
#include "cmSystemTools.h"
class cmExecutionStatus;
// cmUtilitySourceCommand
bool cmUtilitySourceCommand::InitialPass(std::vector<std::string> const& args,
cmExecutionStatus&)
{
if (args.size() < 3) {
this->SetError("called with incorrect number of arguments");
return false;
}
std::vector<std::string>::const_iterator arg = args.begin();
// The first argument is the cache entry name.
2017-05-24 20:18:28 +00:00
std::string const& cacheEntry = *arg++;
const char* cacheValue = this->Makefile->GetDefinition(cacheEntry);
// If it exists already and appears up to date then we are done. If
// the string contains "(IntDir)" but that is not the
// CMAKE_CFG_INTDIR setting then the value is out of date.
const char* intDir =
2006-05-12 18:12:13 +00:00
this->Makefile->GetRequiredDefinition("CMAKE_CFG_INTDIR");
bool haveCacheValue = false;
if (this->Makefile->IsOn("CMAKE_CROSSCOMPILING")) {
2017-08-22 21:42:36 +00:00
haveCacheValue = (cacheValue != nullptr);
if (!haveCacheValue) {
std::string msg = "UTILITY_SOURCE is used in cross compiling mode for ";
msg += cacheEntry;
msg += ". If your intention is to run this executable, you need to "
"preload the cache with the full path to a version of that "
"program, which runs on this build machine.";
cmSystemTools::Message(msg.c_str(), "Warning");
}
} else {
cmState* state = this->Makefile->GetState();
haveCacheValue =
2017-08-22 21:42:36 +00:00
(cacheValue && (strstr(cacheValue, "(IntDir)") == nullptr ||
(intDir && strcmp(intDir, "$(IntDir)") == 0)) &&
(state->GetCacheMajorVersion() != 0 &&
state->GetCacheMinorVersion() != 0));
}
if (haveCacheValue) {
return true;
}
// The second argument is the utility's executable name, which will be
// needed later.
2017-05-24 20:18:28 +00:00
std::string const& utilityName = *arg++;
// The third argument specifies the relative directory of the source
// of the utility.
2017-05-24 20:18:28 +00:00
std::string const& relativeSource = *arg++;
std::string utilitySource = this->Makefile->GetCurrentSourceDirectory();
utilitySource = utilitySource + "/" + relativeSource;
// If the directory doesn't exist, the source has not been included.
if (!cmSystemTools::FileExists(utilitySource.c_str())) {
return true;
}
// Make sure all the files exist in the source directory.
while (arg != args.end()) {
std::string file = utilitySource + "/" + *arg++;
if (!cmSystemTools::FileExists(file.c_str())) {
return true;
}
}
// The source exists.
std::string cmakeCFGout =
2006-03-15 16:02:08 +00:00
this->Makefile->GetRequiredDefinition("CMAKE_CFG_INTDIR");
std::string utilityDirectory = this->Makefile->GetCurrentBinaryDirectory();
std::string exePath;
if (this->Makefile->GetDefinition("EXECUTABLE_OUTPUT_PATH")) {
2006-03-15 16:02:08 +00:00
exePath = this->Makefile->GetDefinition("EXECUTABLE_OUTPUT_PATH");
}
if (!exePath.empty()) {
utilityDirectory = exePath;
} else {
utilityDirectory += "/" + relativeSource;
}
// Construct the cache entry for the executable's location.
std::string utilityExecutable = utilityDirectory + "/" + cmakeCFGout + "/" +
utilityName + this->Makefile->GetDefinition("CMAKE_EXECUTABLE_SUFFIX");
// make sure we remove any /./ in the name
cmSystemTools::ReplaceString(utilityExecutable, "/./", "/");
// Enter the value into the cache.
this->Makefile->AddCacheDefinition(cacheEntry, utilityExecutable.c_str(),
"Path to an internal program.",
cmStateEnums::FILEPATH);
// add a value into the cache that maps from the
// full path to the name of the project
cmSystemTools::ConvertToUnixSlashes(utilityExecutable);
this->Makefile->AddCacheDefinition(utilityExecutable, utilityName.c_str(),
"Executable to project name.",
cmStateEnums::INTERNAL);
return true;
}