CMake/Source/cmProjectCommand.h

90 lines
2.4 KiB
C
Raw Normal View History

2001-01-11 16:04:28 +03:00
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
2002-01-21 23:30:43 +03:00
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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
#include "cmStandardIncludes.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);
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-02-15 21:30:13 +03:00
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{
return true;
}
2001-01-11 16:04:28 +03:00
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation()
{
2001-01-11 16:04:28 +03:00
return "Set a name for the entire project. One argument.";
}
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 [C++ C Java])\n"
"Sets the name of the project. "
"This creates the variables projectname_BINARY_DIR and projectname_SOURCE_DIR. "
"Optionally you can specify which languages your project supports. "
"By default all languages are supported. If you do not have a C++ compiler, but want"
" to build a c program with cmake, then use this option.";
}
cmTypeMacro(cmProjectCommand, cmCommand);
};
#endif