mirror of
https://github.com/reactos/CMake.git
synced 2024-12-11 21:34:32 +00:00
96afb12087
This converts the CMake license to a pure 3-clause OSI-approved BSD License. We drop the previous license clause requiring modified versions to be plainly marked. We also update the CMake copyright to cover the full development time range.
83 lines
2.4 KiB
C++
83 lines
2.4 KiB
C++
/*============================================================================
|
|
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 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);
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "variable_requires";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Deprecated. Use the if() command instead.";
|
|
}
|
|
|
|
/**
|
|
* 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"
|
|
"The first argument (TEST_VARIABLE) is the name of the variable to be "
|
|
"tested, if that variable is false nothing else is done. If "
|
|
"TEST_VARIABLE is true, then "
|
|
"the next argument (RESULT_VARIABLE) is a variable that is set to true "
|
|
"if all the required variables are set. "
|
|
"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.";
|
|
}
|
|
|
|
/** This command is kept for compatibility with older CMake versions. */
|
|
virtual bool IsDiscouraged()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
cmTypeMacro(cmVariableRequiresCommand, cmCommand);
|
|
};
|
|
|
|
|
|
#endif
|