| /*========================================================================= |
| |
| Program: CMake - Cross-Platform Makefile Generator |
| Module: $RCSfile$ |
| Language: C++ |
| Date: $Date$ |
| Version: $Revision$ |
| |
| Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. |
| See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. |
| |
| This software is distributed WITHOUT ANY WARRANTY; without even |
| the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| PURPOSE. See the above copyright notices for more information. |
| |
| =========================================================================*/ |
| #include "cmMacroCommand.h" |
| |
| #include "cmake.h" |
| |
| // define the class for macro commands |
| class cmMacroHelperCommand : public cmCommand |
| { |
| public: |
| cmMacroHelperCommand() {} |
| |
| ///! clean up any memory allocated by the macro |
| ~cmMacroHelperCommand() {}; |
| |
| /** |
| * This is a virtual constructor for the command. |
| */ |
| virtual cmCommand* Clone() |
| { |
| cmMacroHelperCommand *newC = new cmMacroHelperCommand; |
| // we must copy when we clone |
| newC->Args = this->Args; |
| newC->Functions = this->Functions; |
| return newC; |
| } |
| |
| /** |
| * This determines if the command is invoked when in script mode. |
| */ |
| virtual bool IsScriptable() { return true; } |
| |
| /** |
| * This is called when the command is first encountered in |
| * the CMakeLists.txt file. |
| */ |
| virtual bool InvokeInitialPass(const std::vector<cmListFileArgument>& args); |
| |
| virtual bool InitialPass(std::vector<std::string> const&) { return false; }; |
| |
| /** |
| * The name of the command as specified in CMakeList.txt. |
| */ |
| virtual const char* GetName() { return this->Args[0].c_str(); } |
| |
| /** |
| * Succinct documentation. |
| */ |
| virtual const char* GetTerseDocumentation() |
| { |
| std::string docs = "Macro named: "; |
| docs += this->GetName(); |
| return docs.c_str(); |
| } |
| |
| /** |
| * More documentation. |
| */ |
| virtual const char* GetFullDocumentation() |
| { |
| return this->GetTerseDocumentation(); |
| } |
| |
| cmTypeMacro(cmMacroHelperCommand, cmCommand); |
| |
| std::vector<std::string> Args; |
| std::vector<cmListFileFunction> Functions; |
| }; |
| |
| |
| bool cmMacroHelperCommand::InvokeInitialPass |
| (const std::vector<cmListFileArgument>& args) |
| { |
| // Expand the argument list to the macro. |
| std::vector<std::string> expandedArgs; |
| this->Makefile->ExpandArguments(args, expandedArgs); |
| |
| std::string tmps; |
| cmListFileArgument arg; |
| std::string variable; |
| |
| // make sure the number of arguments passed is at least the number |
| // required by the signature |
| if (expandedArgs.size() < this->Args.size() - 1) |
| { |
| std::string errorMsg = |
| "Macro invoked with incorrect arguments for macro named: "; |
| errorMsg += this->Args[0]; |
| this->SetError(errorMsg.c_str()); |
| return false; |
| } |
| |
| // set the value of argc |
| cmOStringStream argcDefStream; |
| argcDefStream << expandedArgs.size(); |
| std::string argcDef = argcDefStream.str(); |
| |
| // declare varuiables for ARGV ARGN but do not compute until needed |
| std::string argvDef; |
| std::string argnDef; |
| bool argnDefInitialized = false; |
| bool argvDefInitialized = false; |
| |
| // 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. |
| newLFF.Arguments.clear(); |
| newLFF.Arguments.reserve(this->Functions[c].Arguments.size()); |
| newLFF.Name = this->Functions[c].Name; |
| newLFF.FilePath = this->Functions[c].FilePath; |
| newLFF.Line = this->Functions[c].Line; |
| const char* def = this->Makefile->GetDefinition |
| ("CMAKE_MACRO_REPORT_DEFINITION_LOCATION"); |
| bool macroReportLocation = false; |
| if(def && !cmSystemTools::IsOff(def)) |
| { |
| macroReportLocation = true; |
| } |
| |
| // for each argument of the current function |
| for (std::vector<cmListFileArgument>::const_iterator k = |
| this->Functions[c].Arguments.begin(); |
| k != this->Functions[c].Arguments.end(); ++k) |
| { |
| tmps = k->Value; |
| // replace formal arguments |
| for (unsigned int j = 1; j < this->Args.size(); ++j) |
| { |
| variable = "${"; |
| variable += this->Args[j]; |
| variable += "}"; |
| cmSystemTools::ReplaceString(tmps, variable.c_str(), |
| expandedArgs[j-1].c_str()); |
| } |
| // replace argc |
| cmSystemTools::ReplaceString(tmps, "${ARGC}",argcDef.c_str()); |
| |
| // repleace ARGN |
| if (tmps.find("${ARGN}") != std::string::npos) |
| { |
| if (!argnDefInitialized) |
| { |
| std::vector<std::string>::const_iterator eit; |
| std::vector<std::string>::size_type cnt = 0; |
| for ( eit = expandedArgs.begin(); eit != expandedArgs.end(); ++eit ) |
| { |
| if ( cnt >= this->Args.size()-1 ) |
| { |
| if ( argnDef.size() > 0 ) |
| { |
| argnDef += ";"; |
| } |
| argnDef += *eit; |
| } |
| cnt ++; |
| } |
| argnDefInitialized = true; |
| } |
| cmSystemTools::ReplaceString(tmps, "${ARGN}", argnDef.c_str()); |
| } |
| |
| // if the current argument of the current function has ${ARGV in it |
| // then try replacing ARGV values |
| if (tmps.find("${ARGV") != std::string::npos) |
| { |
| char argvName[60]; |
| |
| // repleace ARGV, compute it only once |
| if (!argvDefInitialized) |
| { |
| std::vector<std::string>::const_iterator eit; |
| for ( eit = expandedArgs.begin(); eit != expandedArgs.end(); ++eit ) |
| { |
| if ( argvDef.size() > 0 ) |
| { |
| argvDef += ";"; |
| } |
| argvDef += *eit; |
| } |
| argvDefInitialized = true; |
| } |
| cmSystemTools::ReplaceString(tmps, "${ARGV}", argvDef.c_str()); |
| |
| // also replace the ARGV1 ARGV2 ... etc |
| for (unsigned int t = 0; t < expandedArgs.size(); ++t) |
| { |
| sprintf(argvName,"${ARGV%i}",t); |
| cmSystemTools::ReplaceString(tmps, argvName, |
| expandedArgs[t].c_str()); |
| } |
| } |
| |
| arg.Value = tmps; |
| arg.Quoted = k->Quoted; |
| if(macroReportLocation) |
| { |
| // Report the location of the argument where the macro was |
| // defined. |
| arg.FilePath = k->FilePath; |
| arg.Line = k->Line; |
| } |
| else |
| { |
| // Report the location of the argument where the macro was |
| // invoked. |
| if (args.size()) |
| { |
| arg.FilePath = args[0].FilePath; |
| arg.Line = args[0].Line; |
| } |
| else |
| { |
| arg.FilePath = "Unknown"; |
| arg.Line = 0; |
| } |
| } |
| newLFF.Arguments.push_back(arg); |
| } |
| if(!this->Makefile->ExecuteCommand(newLFF)) |
| { |
| if(args.size()) |
| { |
| arg.FilePath = args[0].FilePath; |
| arg.Line = args[0].Line; |
| } |
| else |
| { |
| arg.FilePath = "Unknown"; |
| arg.Line = 0; |
| } |
| cmOStringStream error; |
| error << "Error in cmake code at\n" |
| << arg.FilePath << ":" << arg.Line << ":\n" |
| << "A command failed during the invocation of macro \"" |
| << this->Args[0].c_str() << "\"."; |
| cmSystemTools::Error(error.str().c_str()); |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| bool cmMacroFunctionBlocker:: |
| IsFunctionBlocked(const cmListFileFunction& lff, cmMakefile &mf) |
| { |
| // 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")) |
| { |
| this->Depth++; |
| } |
| else if(!cmSystemTools::Strucmp(lff.Name.c_str(),"endmacro")) |
| { |
| // if this is the endmacro for this macro then execute |
| if (!this->Depth) |
| { |
| std::string name = this->Args[0]; |
| std::vector<std::string>::size_type cc; |
| name += "("; |
| for ( cc = 0; cc < this->Args.size(); cc ++ ) |
| { |
| name += " " + this->Args[cc]; |
| } |
| name += " )"; |
| mf.AddMacro(this->Args[0].c_str(), name.c_str()); |
| // create a new command and add it to cmake |
| cmMacroHelperCommand *f = new cmMacroHelperCommand(); |
| f->Args = this->Args; |
| f->Functions = this->Functions; |
| std::string newName = "_" + this->Args[0]; |
| mf.GetCMakeInstance()->RenameCommand(this->Args[0].c_str(), |
| newName.c_str()); |
| mf.AddCommand(f); |
| |
| // remove the function blocker now that the macro is defined |
| mf.RemoveFunctionBlocker(lff); |
| return true; |
| } |
| else |
| { |
| // decrement for each nested macro that ends |
| this->Depth--; |
| } |
| } |
| |
| // if it wasn't an endmacro and we are not executing then we must be |
| // recording |
| this->Functions.push_back(lff); |
| return true; |
| } |
| |
| |
| bool cmMacroFunctionBlocker:: |
| ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf) |
| { |
| if(!cmSystemTools::Strucmp(lff.Name.c_str(),"endmacro")) |
| { |
| std::vector<std::string> expandedArguments; |
| mf.ExpandArguments(lff.Arguments, expandedArguments); |
| if ((!expandedArguments.empty() && |
| (expandedArguments[0] == this->Args[0])) |
| || mf.IsOn("CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS")) |
| { |
| return true; |
| } |
| } |
| |
| return false; |
| } |
| |
| void cmMacroFunctionBlocker:: |
| ScopeEnded(cmMakefile &mf) |
| { |
| // macros should end with an EndMacro |
| cmSystemTools::Error( |
| "The end of a CMakeLists file was reached with a MACRO statement that " |
| "was not closed properly. Within the directory: ", |
| mf.GetCurrentDirectory(), " with macro ", |
| this->Args[0].c_str()); |
| } |
| |
| bool cmMacroCommand::InitialPass(std::vector<std::string> const& args) |
| { |
| if(args.size() < 1) |
| { |
| this->SetError("called with incorrect number of arguments"); |
| return false; |
| } |
| |
| // create a function blocker |
| cmMacroFunctionBlocker *f = new cmMacroFunctionBlocker(); |
| for(std::vector<std::string>::const_iterator j = args.begin(); |
| j != args.end(); ++j) |
| { |
| f->Args.push_back(*j); |
| } |
| this->Makefile->AddFunctionBlocker(f); |
| return true; |
| } |
| |