CMake/Source/cmForEachCommand.h

118 lines
3.5 KiB
C
Raw Normal View History

2001-07-26 00:52:51 +04:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-07-26 00:52:51 +04:00
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.
2001-07-26 00:52:51 +04:00
2002-01-21 23:30:43 +03:00
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.
2001-07-26 00:52:51 +04:00
=========================================================================*/
#ifndef cmForEachCommand_h
#define cmForEachCommand_h
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
2001-07-26 00:52:51 +04:00
/** \class cmForEachFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmForEachFunctionBlocker : public cmFunctionBlocker
{
public:
2006-03-15 19:02:08 +03:00
cmForEachFunctionBlocker() {this->Executing = false;}
2001-07-26 00:52:51 +04:00
virtual ~cmForEachFunctionBlocker() {}
virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
2001-07-26 00:52:51 +04:00
cmMakefile &mf);
virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf);
2001-07-26 00:52:51 +04:00
virtual void ScopeEnded(cmMakefile &mf);
2006-03-15 19:02:08 +03:00
std::vector<std::string> Args;
std::vector<cmListFileFunction> Functions;
bool Executing;
2001-07-26 00:52:51 +04:00
};
/** \class cmForEachCommand
* \brief starts an if block
*
* cmForEachCommand starts an if block
*/
class cmForEachCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmForEachCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-07-26 00:52:51 +04:00
2004-02-06 21:47:11 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
2001-07-26 00:52:51 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FOREACH";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Evaluate a group of commands for each value in a list.";
2001-07-26 00:52:51 +04:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" FOREACH(loop_var arg1 arg2 ...)\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDFOREACH(loop_var)\n"
2004-04-29 23:12:40 +04:00
" FOREACH(loop_var RANGE total)\n"
" FOREACH(loop_var RANGE start stop [step])\n"
"All commands between FOREACH and the matching ENDFOREACH are recorded "
"without being invoked. Once the ENDFOREACH is evaluated, the "
"recorded list of commands is invoked once for each argument listed "
"in the original FOREACH command. Before each iteration of the loop "
"\"${loop_var}\" will be set as a variable with "
2004-04-29 23:12:40 +04:00
"the current value in the list.\n"
2005-11-16 20:05:04 +03:00
"Foreach can also iterate over a generated range of numbers. "
"There are three types of this iteration:\n"
2004-04-29 23:12:40 +04:00
"* When specifying single number, the range will have elements "
"0 to \"total\".\n"
"* When specifying two numbers, the range will have elements from "
"the first number to the second number.\n"
"* The third optional number is the increment used to iterate from "
"the first number to the second number.";
2001-07-26 00:52:51 +04:00
}
cmTypeMacro(cmForEachCommand, cmCommand);
};
#endif