CMake/Source/cmMacroCommand.cxx

240 lines
7.9 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. */
2002-08-13 23:46:33 +04:00
#include "cmMacroCommand.h"
2015-03-08 15:51:20 +03:00
#include "cmAlgorithms.h"
#include "cmake.h"
// define the class for macro commands
class cmMacroHelperCommand : public cmCommand
2002-08-13 23:46:33 +04:00
{
public:
cmMacroHelperCommand() {}
2006-03-10 21:06:26 +03:00
///! clean up any memory allocated by the macro
2016-06-27 22:25:27 +03:00
~cmMacroHelperCommand() CM_OVERRIDE {}
2006-03-10 21:06:26 +03:00
/**
* This is used to avoid including this command
* in documentation. This is mainly used by
* cmMacroHelperCommand and cmFunctionHelperCommand
* which cannot provide appropriate documentation.
*/
2016-06-27 22:25:27 +03:00
bool ShouldAppearInDocumentation() const CM_OVERRIDE { return false; }
/**
* This is a virtual constructor for the command.
*/
2016-06-27 22:25:27 +03:00
cmCommand* Clone() CM_OVERRIDE
{
cmMacroHelperCommand* newC = new cmMacroHelperCommand;
// we must copy when we clone
2006-03-15 19:02:08 +03:00
newC->Args = this->Args;
newC->Functions = this->Functions;
newC->FilePath = this->FilePath;
newC->Policies = this->Policies;
return newC;
}
2006-03-10 21:06:26 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
2016-06-27 22:25:27 +03:00
bool IsScriptable() const CM_OVERRIDE { return true; }
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
2016-06-27 22:25:27 +03:00
bool InvokeInitialPass(const std::vector<cmListFileArgument>& args,
cmExecutionStatus&) CM_OVERRIDE;
2016-06-27 22:25:27 +03:00
bool InitialPass(std::vector<std::string> const&,
cmExecutionStatus&) CM_OVERRIDE
{
return false;
}
2006-03-10 21:06:26 +03:00
/**
* The name of the command as specified in CMakeList.txt.
*/
2016-06-27 22:25:27 +03:00
std::string GetName() const CM_OVERRIDE { return this->Args[0]; }
cmTypeMacro(cmMacroHelperCommand, cmCommand);
2006-03-15 19:02:08 +03:00
std::vector<std::string> Args;
std::vector<cmListFileFunction> Functions;
cmPolicies::PolicyMap Policies;
std::string FilePath;
};
bool cmMacroHelperCommand::InvokeInitialPass(
const std::vector<cmListFileArgument>& args, cmExecutionStatus& inStatus)
{
// Expand the argument list to the macro.
std::vector<std::string> expandedArgs;
2006-03-15 19:02:08 +03:00
this->Makefile->ExpandArguments(args, expandedArgs);
2006-03-10 21:06:26 +03:00
// make sure the number of arguments passed is at least the number
// required by the signature
if (expandedArgs.size() < this->Args.size() - 1) {
2006-03-10 21:06:26 +03:00
std::string errorMsg =
"Macro invoked with incorrect arguments for macro named: ";
2006-03-15 19:02:08 +03:00
errorMsg += this->Args[0];
this->SetError(errorMsg);
return false;
}
2006-03-10 21:06:26 +03:00
cmMakefile::MacroPushPop macroScope(this->Makefile, this->FilePath,
this->Policies);
// set the value of argc
std::ostringstream argcDefStream;
argcDefStream << expandedArgs.size();
std::string argcDef = argcDefStream.str();
2006-03-10 21:06:26 +03:00
std::vector<std::string>::const_iterator eit =
expandedArgs.begin() + (this->Args.size() - 1);
std::string expandedArgn = cmJoin(cmMakeRange(eit, expandedArgs.end()), ";");
std::string expandedArgv = cmJoin(expandedArgs, ";");
std::vector<std::string> variables;
variables.reserve(this->Args.size() - 1);
for (unsigned int j = 1; j < this->Args.size(); ++j) {
variables.push_back("${" + this->Args[j] + "}");
}
std::vector<std::string> argVs;
argVs.reserve(expandedArgs.size());
char argvName[60];
for (unsigned int j = 0; j < expandedArgs.size(); ++j) {
sprintf(argvName, "${ARGV%i}", j);
argVs.push_back(argvName);
}
// Invoke all the functions that were collected in the block.
cmListFileFunction newLFF;
// for each function
for (unsigned int c = 0; c < this->Functions.size(); ++c) {
// Replace the formal arguments and then invoke the command.
2006-03-15 19:02:08 +03:00
newLFF.Arguments.clear();
newLFF.Arguments.reserve(this->Functions[c].Arguments.size());
newLFF.Name = this->Functions[c].Name;
newLFF.Line = this->Functions[c].Line;
2006-03-10 21:06:26 +03:00
// for each argument of the current function
for (std::vector<cmListFileArgument>::iterator k =
2006-03-15 19:02:08 +03:00
this->Functions[c].Arguments.begin();
k != this->Functions[c].Arguments.end(); ++k) {
cmListFileArgument arg;
arg.Value = k->Value;
if (k->Delim != cmListFileArgument::Bracket) {
// replace formal arguments
for (unsigned int j = 0; j < variables.size(); ++j) {
cmSystemTools::ReplaceString(arg.Value, variables[j],
expandedArgs[j]);
}
// replace argc
cmSystemTools::ReplaceString(arg.Value, "${ARGC}", argcDef);
cmSystemTools::ReplaceString(arg.Value, "${ARGN}", expandedArgn);
cmSystemTools::ReplaceString(arg.Value, "${ARGV}", expandedArgv);
2006-03-10 21:06:26 +03:00
// if the current argument of the current function has ${ARGV in it
// then try replacing ARGV values
if (arg.Value.find("${ARGV") != std::string::npos) {
for (unsigned int t = 0; t < expandedArgs.size(); ++t) {
cmSystemTools::ReplaceString(arg.Value, argVs[t], expandedArgs[t]);
}
}
}
arg.Delim = k->Delim;
arg.Line = k->Line;
2006-03-15 19:02:08 +03:00
newLFF.Arguments.push_back(arg);
}
cmExecutionStatus status;
if (!this->Makefile->ExecuteCommand(newLFF, status) ||
status.GetNestedError()) {
// The error message should have already included the call stack
// so we do not need to report an error here.
macroScope.Quiet();
inStatus.SetNestedError(true);
return false;
}
if (status.GetReturnInvoked()) {
inStatus.SetReturnInvoked(true);
return true;
}
if (status.GetBreakInvoked()) {
inStatus.SetBreakInvoked(true);
return true;
}
}
return true;
}
bool cmMacroFunctionBlocker::IsFunctionBlocked(const cmListFileFunction& lff,
cmMakefile& mf,
cmExecutionStatus&)
{
// record commands until we hit the ENDMACRO
// at the ENDMACRO call we shift gears and start looking for invocations
if (!cmSystemTools::Strucmp(lff.Name.c_str(), "macro")) {
2006-05-23 17:11:46 +04:00
this->Depth++;
} else if (!cmSystemTools::Strucmp(lff.Name.c_str(), "endmacro")) {
2006-05-23 17:11:46 +04:00
// if this is the endmacro for this macro then execute
if (!this->Depth) {
mf.AppendProperty("MACROS", this->Args[0].c_str());
// create a new command and add it to cmake
cmMacroHelperCommand* f = new cmMacroHelperCommand();
2006-03-15 19:02:08 +03:00
f->Args = this->Args;
f->Functions = this->Functions;
f->FilePath = this->GetStartingContext().FilePath;
mf.RecordPolicies(f->Policies);
2006-03-15 19:02:08 +03:00
std::string newName = "_" + this->Args[0];
2015-04-11 13:52:14 +03:00
mf.GetState()->RenameCommand(this->Args[0], newName);
mf.GetState()->AddCommand(f);
2006-03-10 21:06:26 +03:00
// remove the function blocker now that the macro is defined
mf.RemoveFunctionBlocker(this, lff);
return true;
2002-08-13 23:46:33 +04:00
}
2016-09-16 23:45:24 +03:00
// decrement for each nested macro that ends
this->Depth--;
}
2006-03-10 21:06:26 +03:00
// if it wasn't an endmacro and we are not executing then we must be
// recording
2006-03-15 19:02:08 +03:00
this->Functions.push_back(lff);
return true;
2002-08-13 23:46:33 +04:00
}
2006-03-10 21:06:26 +03:00
bool cmMacroFunctionBlocker::ShouldRemove(const cmListFileFunction& lff,
cmMakefile& mf)
2002-08-13 23:46:33 +04:00
{
if (!cmSystemTools::Strucmp(lff.Name.c_str(), "endmacro")) {
std::vector<std::string> expandedArguments;
mf.ExpandArguments(lff.Arguments, expandedArguments,
this->GetStartingContext().FilePath.c_str());
// if the endmacro has arguments make sure they
// match the arguments of the macro
if ((expandedArguments.empty() ||
(expandedArguments[0] == this->Args[0]))) {
return true;
}
}
2006-05-23 17:11:46 +04:00
2002-08-13 23:46:33 +04:00
return false;
}
bool cmMacroCommand::InitialPass(std::vector<std::string> const& args,
cmExecutionStatus&)
2002-08-13 23:46:33 +04:00
{
if (args.empty()) {
2002-08-13 23:46:33 +04:00
this->SetError("called with incorrect number of arguments");
return false;
}
2006-03-10 21:06:26 +03:00
2002-08-13 23:46:33 +04:00
// create a function blocker
cmMacroFunctionBlocker* f = new cmMacroFunctionBlocker();
f->Args.insert(f->Args.end(), args.begin(), args.end());
2006-03-15 19:02:08 +03:00
this->Makefile->AddFunctionBlocker(f);
2002-08-13 23:46:33 +04:00
return true;
}