blob: c86f43dc675150044969cffeaf75870e33a2bcf8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/*============================================================================
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() const { return "variable_requires";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Deprecated. Use the if() command instead.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
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() const
{
return true;
}
cmTypeMacro(cmVariableRequiresCommand, cmCommand);
};
#endif
|
