CMake/Source/cmMacroCommand.h

121 lines
3.8 KiB
C
Raw Normal View History

2009-10-02 01:21:28 +04:00
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2002-08-13 23:46:33 +04:00
2009-10-02 01:21:28 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2002-08-13 23:46:33 +04:00
2009-10-02 01:21:28 +04:00
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
2002-08-13 23:46:33 +04:00
#ifndef cmMacroCommand_h
#define cmMacroCommand_h
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
/** \class cmMacroFunctionBlocker
* \brief subclass of function blocker
*
2006-03-10 21:06:26 +03:00
*
2002-08-13 23:46:33 +04:00
*/
class cmMacroFunctionBlocker : public cmFunctionBlocker
{
public:
2006-05-23 17:11:46 +04:00
cmMacroFunctionBlocker() {this->Depth=0;}
2002-08-13 23:46:33 +04:00
virtual ~cmMacroFunctionBlocker() {}
virtual bool IsFunctionBlocked(const cmListFileFunction&,
cmMakefile &mf,
cmExecutionStatus &);
virtual bool ShouldRemove(const cmListFileFunction&, cmMakefile &mf);
2006-03-15 19:02:08 +03:00
std::vector<std::string> Args;
std::vector<cmListFileFunction> Functions;
2006-05-23 17:11:46 +04:00
int Depth;
2002-08-13 23:46:33 +04:00
};
/** \class cmMacroCommand
* \brief starts an if block
*
* cmMacroCommand starts an if block
*/
class cmMacroCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
2006-03-10 21:06:26 +03:00
virtual cmCommand* Clone()
2002-08-13 23:46:33 +04:00
{
return new cmMacroCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2002-08-13 23:46:33 +04:00
2004-02-19 17:35:30 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
2002-08-13 23:46:33 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "macro";}
2002-08-13 23:46:33 +04:00
/**
* Succinct documentation.
*/
2006-03-10 21:06:26 +03:00
virtual const char* GetTerseDocumentation()
2002-08-13 23:46:33 +04:00
{
return "Start recording a macro for later invocation as a command.";
2002-08-13 23:46:33 +04:00
}
2006-03-10 21:06:26 +03:00
2002-08-13 23:46:33 +04:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" macro(<name> [arg1 [arg2 [arg3 ...]]])\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" endmacro(<name>)\n"
"Define a macro named <name> that takes arguments named "
"arg1 arg2 arg3 (...). Commands listed after macro, "
"but before the matching endmacro, are not invoked until the macro "
"is invoked. When it is invoked, the commands recorded in the "
2006-03-10 21:06:26 +03:00
"macro are first modified by replacing formal parameters (${arg1}) "
"with the arguments passed, and then invoked as normal commands. In "
2004-04-26 19:11:57 +04:00
"addition to referencing the formal parameters you can reference "
2008-01-18 20:26:45 +03:00
"the values ${ARGC} which will be set to the number of arguments "
"passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} "
"... which "
2004-04-26 19:11:57 +04:00
"will have the actual values of the arguments passed in. This "
2005-11-16 22:41:10 +03:00
"facilitates creating macros with optional arguments. Additionally "
2008-01-18 20:26:45 +03:00
"${ARGV} holds the list of all arguments given to the macro and "
"${ARGN} "
2009-07-31 14:22:18 +04:00
"holds the list of argument past the last expected argument. "
2008-01-18 20:26:45 +03:00
"Note that the parameters to a macro and values such as ARGN "
"are not variables in the usual CMake sense. They are string "
"replacements much like the c preprocessor would do with a "
"macro. If you want true CMake variables you should look at "
"the function command."
"\n"
"See the cmake_policy() command documentation for the behavior of "
"policies inside macros."
;
2002-08-13 23:46:33 +04:00
}
2006-03-10 21:06:26 +03:00
2002-08-13 23:46:33 +04:00
cmTypeMacro(cmMacroCommand, cmCommand);
};
#endif