CMake/Source/cmProjectCommand.h

85 lines
2.5 KiB
C
Raw Normal View History

2001-01-11 16:04:28 +03:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-01-11 16:04:28 +03:00
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2001-01-11 16:04:28 +03:00
2002-01-21 23:30:43 +03:00
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.
2001-01-11 16:04:28 +03:00
=========================================================================*/
2001-01-18 19:20:24 +03:00
#ifndef cmProjectCommand_h
#define cmProjectCommand_h
2001-01-18 19:20:24 +03:00
#include "cmCommand.h"
2001-01-18 19:20:24 +03:00
/** \class cmProjectCommand
2001-01-11 16:04:28 +03:00
* \brief Specify the name for this build project.
*
2001-01-18 19:20:24 +03:00
* cmProjectCommand is used to specify a name for this build project.
2001-01-11 16:04:28 +03:00
* It is defined once per set of CMakeList.txt files (including
2001-02-15 21:30:13 +03:00
* all subdirectories). Currently it just sets the name of the workspace
* file for Microsoft Visual C++
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
class cmProjectCommand : public cmCommand
{
public:
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is a virtual constructor for the command.
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
virtual cmCommand* Clone()
{
2001-01-18 19:20:24 +03:00
return new cmProjectCommand;
}
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is called when the command is first encountered in
2001-01-11 16:04:28 +03:00
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* The name of the command as specified in CMakeList.txt.
2001-01-11 16:04:28 +03:00
*/
virtual const char* GetName() {return "project";}
2001-01-11 16:04:28 +03:00
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation()
{
return "Set a name for the entire project.";
}
2001-01-11 16:04:28 +03:00
/**
* More documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetFullDocumentation()
{
2001-01-11 16:04:28 +03:00
return
" project(<projectname> [languageName1 languageName2 ... ] )\n"
"Sets the name of the project. "
"Additionally this sets the variables <projectName>_BINARY_DIR and "
"<projectName>_SOURCE_DIR to the respective values.\n"
"Optionally you can specify which languages your project supports. "
"Example languages are CXX (i.e. C++), C, Fortran, etc. "
"By default C and CXX are enabled. E.g. if you do not have a "
"C++ compiler, you can disable the check for it by explicitely listing "
"the languages you want to support, e.g. C. By using the special "
"language \"NONE\" all checks for any language can be disabled.";
}
cmTypeMacro(cmProjectCommand, cmCommand);
};
#endif