CMake/Source/cmVariableRequiresCommand.h

80 lines
2.3 KiB
C
Raw Normal View History

2001-11-19 17:34:29 +03:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-11-19 17:34:29 +03:00
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.
2001-11-19 17:34:29 +03:00
2002-01-21 23:30:43 +03:00
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.
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);
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 "Assert satisfaction of an option's required variables.";
2001-11-19 17:34:29 +03:00
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" 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
}
cmTypeMacro(cmVariableRequiresCommand, cmCommand);
};
#endif