CMake/Source/cmConfigureFileCommand.cxx

109 lines
3.4 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-08 02:11:16 +04:00
#include "cmConfigureFileCommand.h"
2001-04-27 22:25:42 +04:00
#include <cmsys/RegularExpression.hxx>
2001-05-08 02:11:16 +04:00
// cmConfigureFileCommand
bool cmConfigureFileCommand::InitialPass(std::vector<std::string> const& args,
cmExecutionStatus&)
2001-04-27 22:25:42 +04:00
{
if (args.size() < 2) {
2001-04-27 22:25:42 +04:00
this->SetError("called with incorrect number of arguments, expected 2");
return false;
}
const char* inFile = args[0].c_str();
if (!cmSystemTools::FileIsFullPath(inFile)) {
this->InputFile = this->Makefile->GetCurrentSourceDirectory();
this->InputFile += "/";
}
this->InputFile += inFile;
// If the input location is a directory, error out.
if (cmSystemTools::FileIsDirectory(this->InputFile)) {
std::ostringstream e;
/* clang-format off */
e << "input location\n"
<< " " << this->InputFile << "\n"
<< "is a directory but a file was expected.";
/* clang-format on */
this->SetError(e.str());
return false;
}
const char* outFile = args[1].c_str();
if (!cmSystemTools::FileIsFullPath(outFile)) {
this->OutputFile = this->Makefile->GetCurrentBinaryDirectory();
this->OutputFile += "/";
}
this->OutputFile += outFile;
// If the output location is already a directory put the file in it.
if (cmSystemTools::FileIsDirectory(this->OutputFile)) {
this->OutputFile += "/";
this->OutputFile += cmSystemTools::GetFilenameName(inFile);
}
if (!this->Makefile->CanIWriteThisFile(this->OutputFile.c_str())) {
std::string e = "attempted to configure a file: " + this->OutputFile +
" into a source directory.";
this->SetError(e);
cmSystemTools::SetFatalErrorOccured();
return false;
}
std::string errorMessage;
if (!this->NewLineStyle.ReadFromArguments(args, errorMessage)) {
this->SetError(errorMessage);
return false;
}
2006-03-15 19:02:08 +03:00
this->CopyOnly = false;
this->EscapeQuotes = false;
std::string unknown_args;
2006-03-15 19:02:08 +03:00
this->AtOnly = false;
for (unsigned int i = 2; i < args.size(); ++i) {
if (args[i] == "COPYONLY") {
2006-03-15 19:02:08 +03:00
this->CopyOnly = true;
if (this->NewLineStyle.IsValid()) {
this->SetError("COPYONLY could not be used in combination "
"with NEWLINE_STYLE");
return false;
2001-05-09 17:52:21 +04:00
}
} else if (args[i] == "ESCAPE_QUOTES") {
2006-03-15 19:02:08 +03:00
this->EscapeQuotes = true;
} else if (args[i] == "@ONLY") {
2006-03-15 19:02:08 +03:00
this->AtOnly = true;
} else if (args[i] == "IMMEDIATE") {
/* Ignore legacy option. */
} else if (args[i] == "NEWLINE_STYLE" || args[i] == "LF" ||
args[i] == "UNIX" || args[i] == "CRLF" || args[i] == "WIN32" ||
args[i] == "DOS") {
/* Options handled by NewLineStyle member above. */
} else {
unknown_args += " ";
unknown_args += args[i];
unknown_args += "\n";
}
}
if (!unknown_args.empty()) {
std::string msg = "configure_file called with unknown argument(s):\n";
msg += unknown_args;
this->Makefile->IssueMessage(cmake::AUTHOR_WARNING, msg);
}
if (!this->ConfigureFile()) {
this->SetError("Problem configuring file");
return false;
}
2001-04-27 22:25:42 +04:00
return true;
}
int cmConfigureFileCommand::ConfigureFile()
2001-04-27 22:25:42 +04:00
{
return this->Makefile->ConfigureFile(
this->InputFile.c_str(), this->OutputFile.c_str(), this->CopyOnly,
this->AtOnly, this->EscapeQuotes, this->NewLineStyle);
2001-04-27 22:25:42 +04:00
}