diff options
Diffstat (limited to 'Source/cmOptionCommand.h')
-rw-r--r-- | Source/cmOptionCommand.h | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/Source/cmOptionCommand.h b/Source/cmOptionCommand.h new file mode 100644 index 0000000..7d02400 --- /dev/null +++ b/Source/cmOptionCommand.h @@ -0,0 +1,78 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2009 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#ifndef cmOptionCommand_h +#define cmOptionCommand_h + +#include "cmCommand.h" + +/** \class cmOptionCommand + * \brief Provide an option to the user + * + * cmOptionCommand provides an option for the user to select + */ +class cmOptionCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmOptionCommand; + } + + /** + * 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); + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() const {return "option";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() const + { + return "Provides an option that the user can optionally select."; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() const + { + return + " option(<option_variable> \"help string describing option\"\n" + " [initial value])\n" + "Provide an option for the user to select as ON or OFF. If no " + "initial value is provided, OFF is used.\n" + "If you have options that depend on the values of other " + "options, see the module help for CMakeDependentOption." + ; + } + + /** + * This determines if the command is invoked when in script mode. + */ + virtual bool IsScriptable() const { return true; } + + cmTypeMacro(cmOptionCommand, cmCommand); +}; + + + +#endif |