blob: 7d0240050abdbd3e91a529b354632095f55129f2 (
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
|
/*============================================================================
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 cmOptionCommand_h
#define cmOptionCommand_h
#include "cmCommand.h"
/** \class cmOptionCommand
* \brief Provide an option to the user
*
* cmOptionCommand provides an option for the user to select
*/
class cmOptionCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmOptionCommand;
}
/**
* 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 "option";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Provides an option that the user can optionally select.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" option(<option_variable> \"help string describing option\"\n"
" [initial value])\n"
"Provide an option for the user to select as ON or OFF. If no "
"initial value is provided, OFF is used.\n"
"If you have options that depend on the values of other "
"options, see the module help for CMakeDependentOption."
;
}
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
cmTypeMacro(cmOptionCommand, cmCommand);
};
#endif
|
