CMake/Source/cmRemoveCommand.h

82 lines
2.0 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 cmRemoveCommand_h
#define cmRemoveCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmRemoveCommand
* \brief Set a CMAKE variable
*
* cmRemoveCommand sets a variable to a value with expansion.
*/
class cmRemoveCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmRemoveCommand;
}
/**
* 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 "REMOVE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Remove a value from a CMAKE variable";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"REMOVE(VAR VALUE VALUE ...)\n"
"Removes VALUE from the CMAke variable VAR. "
"This is typically used to remove entries from a vector "
"(e.g. semicolon separated list). VALUE is expanded. ";
}
cmTypeMacro(cmRemoveCommand, cmCommand);
};
#endif