mirror of
https://github.com/reactos/CMake.git
synced 2024-11-24 20:19:53 +00:00
b3b57e7a31
Describe explicitly the scope in which enable_language must be invoked to handle all direct and indirect uses of a language. While at it, re-word documentation of the OPTIONAL keyword to avoid confusion over its partial implementation.
85 lines
2.7 KiB
C++
85 lines
2.7 KiB
C++
/*============================================================================
|
|
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(<lang> [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. "
|
|
"\n"
|
|
"This command must be called in file scope, not in a function call. "
|
|
"Furthermore, it must be called in the highest directory common to "
|
|
"all targets using the named language directly for compiling sources "
|
|
"or indirectly through link dependencies. "
|
|
"It is simplest to enable all needed languages in the top-level "
|
|
"directory of a project."
|
|
"\n"
|
|
"The OPTIONAL keyword is a placeholder for future implementation "
|
|
"and does not currently work.";
|
|
}
|
|
|
|
cmTypeMacro(cmEnableLanguageCommand, cmCommand);
|
|
};
|
|
|
|
|
|
|
|
#endif
|