CMake/Source/cmEndForEachCommand.h

83 lines
2.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 cmEndForEachCommand_h
#define cmEndForEachCommand_h
#include "cmCommand.h"
/** \class cmEndForEachCommand
* \brief ends an if block
*
* cmEndForEachCommand ends an if block
*/
class cmEndForEachCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmEndForEachCommand;
}
/**
* Override cmCommand::InvokeInitialPass to get arguments before
* expansion.
*/
virtual bool InvokeInitialPass(std::vector<cmListFileArgument> const&);
2001-07-26 00:52:51 +04:00
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const&) {return false;}
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 "endforeach";}
2001-07-26 00:52:51 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Ends a list of commands in a FOREACH block.";
2001-07-26 00:52:51 +04:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" endforeach(expression)\n"
2005-11-16 18:37:02 +03:00
"See the FOREACH command.";
2001-07-26 00:52:51 +04:00
}
cmTypeMacro(cmEndForEachCommand, cmCommand);
};
#endif