88 lines
2.4 KiB
C++
88 lines
2.4 KiB
C++
/*=========================================================================
|
|
|
|
Program: Insight Segmentation & Registration Toolkit
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Insight Consortium. All rights reserved.
|
|
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 "cmStandardIncludes.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);
|
|
|
|
/**
|
|
* This determines if the command gets propagated down
|
|
* to makefiles located in subdirectories.
|
|
*/
|
|
virtual bool IsInherited() {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 value";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
"SET(VAR [VALUE] [CACHE TYPE DOCSTRING])\n"
|
|
"Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR "
|
|
"is set to it. If CACHE is present, then the VAR is put in the cache."
|
|
" TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, STRING, INTERNAL, "
|
|
"or STATIC. 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 VAR, then this always "
|
|
"writes into the current makefile.\n"
|
|
"An optional syntax is SET(VAR VALUE1 ... VALUEN).\n"
|
|
"In this case VAR is set to a ; separated list of values.";
|
|
}
|
|
|
|
cmTypeMacro(cmSetCommand, cmCommand);
|
|
};
|
|
|
|
|
|
|
|
#endif
|