diff options
author | Ken Martin <ken.martin@kitware.com> | 2002-04-22 15:50:43 (GMT) |
---|---|---|
committer | Ken Martin <ken.martin@kitware.com> | 2002-04-22 15:50:43 (GMT) |
commit | 9c69be42deb1aba6c37eaad2d5b2c07bae58a13a (patch) | |
tree | b37b8233610560555b7be1b21c560b98da82bab5 /Source/cmRemoveCommand.h | |
parent | 6d58f21a3578a6b06211d9fff28e38ff07759b04 (diff) | |
download | CMake-9c69be42deb1aba6c37eaad2d5b2c07bae58a13a.zip CMake-9c69be42deb1aba6c37eaad2d5b2c07bae58a13a.tar.gz CMake-9c69be42deb1aba6c37eaad2d5b2c07bae58a13a.tar.bz2 |
updated for 1.4
Diffstat (limited to 'Source/cmRemoveCommand.h')
-rw-r--r-- | Source/cmRemoveCommand.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h new file mode 100644 index 0000000..7a73dcd --- /dev/null +++ b/Source/cmRemoveCommand.h @@ -0,0 +1,81 @@ +/*========================================================================= + + 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 |