CMake/Source/cmForEachCommand.h

109 lines
3.0 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:
2002-07-17 18:48:39 +04:00
cmForEachFunctionBlocker() {m_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);
std::vector<std::string> m_Args;
std::vector<cmListFileFunction> m_Functions;
2002-07-17 18:48:39 +04:00
bool m_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
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() {return true;}
/**
* 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"
"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. Each recorded command is modified "
"before invocation to replace any occurrence of \"${loop_var}\" with "
"the current value in the list.";
2001-07-26 00:52:51 +04:00
}
cmTypeMacro(cmForEachCommand, cmCommand);
};
#endif