diff options
Diffstat (limited to 'Source/cmSiteNameCommand.h')
-rw-r--r-- | Source/cmSiteNameCommand.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/Source/cmSiteNameCommand.h b/Source/cmSiteNameCommand.h new file mode 100644 index 0000000..52a63bc --- /dev/null +++ b/Source/cmSiteNameCommand.h @@ -0,0 +1,72 @@ +/*============================================================================ + 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 cmSiteNameCommand_h +#define cmSiteNameCommand_h + +#include "cmCommand.h" + +/** \class cmSiteNameCommand + * \brief site_name command + * + * cmSiteNameCommand implements the site_name CMake command + */ +class cmSiteNameCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmSiteNameCommand; + } + + /** + * 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() const { return true; } + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() const {return "site_name";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() const + { + return "Set the given variable to the name of the computer."; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() const + { + return + " site_name(variable)\n"; + } + + cmTypeMacro(cmSiteNameCommand, cmCommand); +}; + + + +#endif |