ee2b446c95
The set(CACHE) and option() commands should always expose the cache value. Previously we failed to expose the value when it was already set if a local variable definition hid it. When set to NEW, this policy tells the commands to always remove the local variable definition to expose the cache value. See issue #9008.
109 lines
3.7 KiB
C++
109 lines
3.7 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
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.
|
|
|
|
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.
|
|
|
|
=========================================================================*/
|
|
#ifndef cmSetCommand_h
|
|
#define cmSetCommand_h
|
|
|
|
#include "cmCommand.h"
|
|
|
|
/** \class cmSetCommand
|
|
* \brief Set a CMAKE variable
|
|
*
|
|
* cmSetCommand sets a variable to a value with expansion.
|
|
*/
|
|
class cmSetCommand : public cmCommand
|
|
{
|
|
public:
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
return new cmSetCommand;
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* This determines if the command is invoked when in script mode.
|
|
*/
|
|
virtual bool IsScriptable() { return true; }
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() {return "set";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Set a CMAKE variable to a given value.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" set(<variable> <value>\n"
|
|
" [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])\n"
|
|
"Within CMake sets <variable> to the value <value>. <value> is expanded"
|
|
" before <variable> is set to it. If CACHE is present and <variable> "
|
|
"is not yet in the cache, then <variable> is put in the cache. If it is "
|
|
"already in the cache, <variable> is assigned the value stored in the "
|
|
"cache. If CACHE is present, also <type> and <docstring> are "
|
|
"required. <type> is used by the CMake GUI to choose a widget with "
|
|
"which the user sets a value. The value for <type> may be one of\n"
|
|
" FILEPATH = File chooser dialog.\n"
|
|
" PATH = Directory chooser dialog.\n"
|
|
" STRING = Arbitrary string.\n"
|
|
" BOOL = Boolean ON/OFF checkbox.\n"
|
|
" INTERNAL = No GUI entry (used for persistent variables).\n"
|
|
"If <type> is INTERNAL, then the <value> is always written into the "
|
|
"cache, replacing any values existing in the cache. If it is not a "
|
|
"cache variable, then this always writes into the current makefile. The "
|
|
"FORCE option will overwrite the cache value removing any changes by "
|
|
"the user.\n"
|
|
"If PARENT_SCOPE is present, the variable will be set in the scope "
|
|
"above the current scope. Each new directory or function creates a new "
|
|
"scope. This command will set the value of a variable into the parent "
|
|
"directory or calling function (whichever is applicable to the case at "
|
|
"hand).\n"
|
|
"If <value> is not specified then the variable is removed "
|
|
"instead of set. See also: the unset() command.\n"
|
|
" set(<variable> <value1> ... <valueN>)\n"
|
|
"In this case <variable> is set to a semicolon separated list of "
|
|
"values.\n"
|
|
"<variable> can be an environment variable such as:\n"
|
|
" set( ENV{PATH} /home/martink )\n"
|
|
"in which case the environment variable will be set.";
|
|
}
|
|
|
|
cmTypeMacro(cmSetCommand, cmCommand);
|
|
};
|
|
|
|
|
|
|
|
#endif
|