CMake/Source/cmReturnCommand.h

51 lines
1.5 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License 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.
*/
2016-06-27 19:25:27 +00:00
cmCommand* Clone() CM_OVERRIDE { return new cmReturnCommand; }
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
2016-06-27 19:25:27 +00:00
bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus& status) CM_OVERRIDE;
/**
* This determines if the command is invoked when in script mode.
*/
2016-06-27 19:25:27 +00:00
bool IsScriptable() const CM_OVERRIDE { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
2016-06-27 19:25:27 +00:00
std::string GetName() const CM_OVERRIDE { return "return"; }
cmTypeMacro(cmReturnCommand, cmCommand);
};
#endif