CMake/Source/cmVariableRequiresCommand.h

83 lines
2.4 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-11-19 17:34:29 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-11-19 17:34:29 +03:00
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.
============================================================================*/
2001-11-19 17:34:29 +03:00
#ifndef cmVariableRequiresCommand_h
#define cmVariableRequiresCommand_h
#include "cmCommand.h"
/** \class cmVariableRequiresCommand
* \brief Displays a message to the user
*
*/
class cmVariableRequiresCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmVariableRequiresCommand;
}
/**
* 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);
2001-11-19 17:34:29 +03:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "variable_requires";}
2001-11-19 17:34:29 +03:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the if() command instead.";
2001-11-19 17:34:29 +03:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"Assert satisfaction of an option's required variables.\n"
" variable_requires(TEST_VARIABLE RESULT_VARIABLE\n"
" REQUIRED_VARIABLE1\n"
" REQUIRED_VARIABLE2 ...)\n"
2003-02-14 17:54:15 +03:00
"The first argument (TEST_VARIABLE) is the name of the variable to be "
"tested, if that variable is false nothing else is done. If "
2001-11-19 17:34:29 +03:00
"TEST_VARIABLE is true, then "
2005-11-17 19:46:16 +03:00
"the next argument (RESULT_VARIABLE) is a variable that is set to true "
"if all the required variables are set. "
2003-02-14 17:54:15 +03:00
"The rest of the arguments are variables that must be true or not "
"set to NOTFOUND to avoid an error. If any are not true, an error "
"is reported.";
2001-11-19 17:34:29 +03:00
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
2001-11-19 17:34:29 +03:00
cmTypeMacro(cmVariableRequiresCommand, cmCommand);
};
#endif