1
/*=========================================================================
3
Program: Insight Segmentation & Registration Toolkit
4
Module: $RCSfile: cmMarkAsAdvancedCommand.h,v $
6
Date: $Date: 2001/12/07 20:47:39 $
7
Version: $Revision: 1.2 $
9
Copyright (c) 2001 Insight Consortium
12
Redistribution and use in source and binary forms, with or without
13
modification, are permitted provided that the following conditions are met:
15
* Redistributions of source code must retain the above copyright notice,
16
this list of conditions and the following disclaimer.
18
* Redistributions in binary form must reproduce the above copyright notice,
19
this list of conditions and the following disclaimer in the documentation
20
and/or other materials provided with the distribution.
22
* The name of the Insight Consortium, nor the names of any consortium members,
23
nor of any contributors, may be used to endorse or promote products derived
24
from this software without specific prior written permission.
26
* Modified source versions must be plainly marked as such, and must not be
27
misrepresented as being the original software.
29
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS''
30
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
33
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
36
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
37
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40
=========================================================================*/
41
#ifndef cmMarkAsAdvancedCommand_h
42
#define cmMarkAsAdvancedCommand_h
44
#include "cmStandardIncludes.h"
45
#include "cmCommand.h"
47
/** \class cmMarkAsAdvancedCommand
48
* \brief MarkAsAdvanced a CMAKE variable
50
* cmMarkAsAdvancedCommand sets a variable to a value with expansion.
52
class cmMarkAsAdvancedCommand : public cmCommand
56
* This is a virtual constructor for the command.
58
virtual cmCommand* Clone()
60
return new cmMarkAsAdvancedCommand;
64
* This is called when the command is first encountered in
65
* the CMakeLists.txt file.
67
virtual bool InitialPass(std::vector<std::string> const& args);
70
* This determines if the command gets propagated down
71
* to makefiles located in subdirectories.
73
virtual bool IsInherited() {return true;}
76
* The name of the command as specified in CMakeList.txt.
78
virtual const char* GetName() {return "MARK_AS_ADVANCED";}
81
* Succinct documentation.
83
virtual const char* GetTerseDocumentation()
85
return "Mark a cmake varible as advanced.";
91
virtual const char* GetFullDocumentation()
94
"MARK_AS_ADVANCED([CLEAR|FORCE]VAR VAR2 VAR... )\n"
95
"Mark the named variables as advanced. An advanced variable will not be displayed in"
96
" any of the cmake GUIs, unless the show advanced option is on. "
97
"If CLEAR is the first argument advanced variables are changed back to unadvanced."
98
"If FORCE is the first arguement, then the variable is made advanced."
99
"If neither FORCE or CLEAR is specified, new values will be marked as advanced, but if the variable already has an advanced state, it will not be changed.";
102
cmTypeMacro(cmMarkAsAdvancedCommand, cmCommand);