1 /*=========================================================================
3 Program: CMake - Cross-Platform Makefile Generator
4 Module: $RCSfile: cmEndFunctionCommand.h,v $
6 Date: $Date: 2008/01/23 15:27:59 $
7 Version: $Revision: 1.2 $
9 Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
10 See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
12 This software is distributed WITHOUT ANY WARRANTY; without even
13 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 PURPOSE. See the above copyright notices for more information.
16 =========================================================================*/
17 #ifndef cmEndFunctionCommand_h
18 #define cmEndFunctionCommand_h
20 #include "cmCommand.h"
22 /** \class cmEndFunctionCommand
23 * \brief ends an if block
25 * cmEndFunctionCommand ends an if block
27 class cmEndFunctionCommand
: public cmCommand
31 * This is a virtual constructor for the command.
33 virtual cmCommand
* Clone()
35 return new cmEndFunctionCommand
;
39 * Override cmCommand::InvokeInitialPass to get arguments before
42 virtual bool InvokeInitialPass(std::vector
<cmListFileArgument
> const&,
46 * This is called when the command is first encountered in
47 * the CMakeLists.txt file.
49 virtual bool InitialPass(std::vector
<std::string
> const&,
50 cmExecutionStatus
&) {return false;}
53 * This determines if the command is invoked when in script mode.
55 virtual bool IsScriptable() { return true; }
58 * The name of the command as specified in CMakeList.txt.
60 virtual const char* GetName() { return "endfunction";}
63 * Succinct documentation.
65 virtual const char* GetTerseDocumentation()
67 return "Ends a list of commands in a function block.";
73 virtual const char* GetFullDocumentation()
76 " endfunction(expression)\n"
77 "See the function command.";
80 cmTypeMacro(cmEndFunctionCommand
, cmCommand
);