83 lines
2.2 KiB
C
83 lines
2.2 KiB
C
|
/*=========================================================================
|
||
|
|
|
||
|
|
Program: CMake - Cross-Platform Makefile Generator
|
||
|
|
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.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
=========================================================================*/
|
||
|
|
#ifndef cmReturnCommand_h
|
||
|
|
#define cmReturnCommand_h
|
||
|
|
|
||
|
|
#include "cmCommand.h"
|
||
|
|
|
||
|
|
/** \class cmReturnCommand
|
||
|
|
* \brief Return from a directory or function
|
||
|
|
*
|
||
|
|
* cmReturnCommand returns from a directory or function
|
||
|
|
*/
|
||
|
|
class cmReturnCommand : public cmCommand
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* This is a virtual constructor for the command.
|
||
|
|
*/
|
||
|
|
virtual cmCommand* Clone()
|
||
|
|
{
|
||
|
|
return new cmReturnCommand;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This determines if the command is invoked when in script mode.
|
||
|
|
*/
|
||
|
|
virtual bool IsScriptable() { return true; }
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The name of the command as specified in CMakeList.txt.
|
||
|
|
*/
|
||
|
|
virtual const char* GetName() {return "return";}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Succinct documentation.
|
||
|
|
*/
|
||
|
|
virtual const char* GetTerseDocumentation()
|
||
|
|
{
|
||
|
|
return "Return from a directory or function.";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* More documentation.
|
||
|
|
*/
|
||
|
|
virtual const char* GetFullDocumentation()
|
||
|
|
{
|
||
|
|
return
|
||
|
|
" return()\n"
|
||
|
|
"Returns from a directory or function. When this command is "
|
||
|
|
"encountered, it caused process of the current function or "
|
||
|
|
"directory to stop and control is return to the caller of the "
|
||
|
|
"function, or the parent directory if any. Note that a macro "
|
||
|
|
"is not a function and does not handle return liek a function does.";
|
||
|
|
}
|
||
|
|
|
||
|
|
cmTypeMacro(cmReturnCommand, cmCommand);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#endif
|