diff options
Diffstat (limited to 'Source/cmEnableLanguageCommand.h')
-rw-r--r-- | Source/cmEnableLanguageCommand.h | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/Source/cmEnableLanguageCommand.h b/Source/cmEnableLanguageCommand.h new file mode 100644 index 0000000..ee963f9 --- /dev/null +++ b/Source/cmEnableLanguageCommand.h @@ -0,0 +1,81 @@ +/*============================================================================ + 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 cmEnableLanguageCommand_h +#define cmEnableLanguageCommand_h + +#include "cmCommand.h" + +/** \class cmEnableLanguageCommand + * \brief Specify the name for this build project. + * + * cmEnableLanguageCommand is used to specify a name for this build project. + * It is defined once per set of CMakeList.txt files (including + * all subdirectories). Currently it just sets the name of the workspace + * file for Microsoft Visual C++ + */ +class cmEnableLanguageCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmEnableLanguageCommand; + } + + /** + * 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 "enable_language";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() const + { + return "Enable a language (CXX/C/Fortran/etc)"; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() const + { + return + " enable_language(languageName [OPTIONAL] )\n" + "This command enables support for the named language in CMake. " + "This is the same as the project command but does not create " + "any of the extra variables that are created by the project command. " + "Example languages are CXX, C, Fortran. " + "If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS " + "variable to check whether the language has been enabled successfully." + "\n" + "This command must be called on file scope (not inside a function) and " + "the language enabled can only be used in the calling project or its " + "subdirectories added by add_subdirectory(). Also note that at present, " + "the OPTIONAL argument does not work."; + } + + cmTypeMacro(cmEnableLanguageCommand, cmCommand); +}; + + + +#endif |