CMakeLua/Source/cmProjectCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmProjectCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmProjectCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.16 $
   9 =======
  10   Date:      $Date: 2009-03-12 22:43:17 $
  11   Version:   $Revision: 1.17 $
  12 >>>>>>> 1.17
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmProjectCommand_h
  23 #define cmProjectCommand_h
  24
  25 #include "cmCommand.h"
  26
  27 /** \class cmProjectCommand
  28  * \brief Specify the name for this build project.
  29  *
  30  * cmProjectCommand is used to specify a name for this build project.
  31  * It is defined once per set of CMakeList.txt files (including
  32  * all subdirectories). Currently it just sets the name of the workspace
  33  * file for Microsoft Visual C++
  34  */
  35 class cmProjectCommand : public cmCommand
  36 {
  37 public:
  38   /**
  39    * This is a virtual constructor for the command.
  40    */
  41   virtual cmCommand* Clone()
  42     {
  43     return new cmProjectCommand;
  44     }
  45
  46   /**
  47    * This is called when the command is first encountered in
  48    * the CMakeLists.txt file.
  49    */
  50   virtual bool InitialPass(std::vector<std::string> const& args,
  51                            cmExecutionStatus &status);
  52
  53   /**
  54    * The name of the command as specified in CMakeList.txt.
  55    */
  56   virtual const char* GetName() {return "project";}
  57
  58   /**
  59    * Succinct documentation.
  60    */
  61   virtual const char* GetTerseDocumentation()
  62     {
  63     return "Set a name for the entire project.";
  64     }
  65
  66   /**
  67    * More documentation.
  68    */
  69   virtual const char* GetFullDocumentation()
  70     {
  71     return
  72       "  project(<projectname> [languageName1 languageName2 ... ] )\n"
  73       "Sets the name of the project.  "
  74       "Additionally this sets the variables <projectName>_BINARY_DIR and "
  75       "<projectName>_SOURCE_DIR to the respective values.\n"
  76       "Optionally you can specify which languages your project supports.  "
  77       "Example languages are CXX (i.e. C++), C, Fortran, etc. "
  78       "By default C and CXX are enabled.  E.g. if you do not have a "
  79       "C++ compiler, you can disable the check for it by explicitely listing "
  80       "the languages you want to support, e.g. C.  By using the special "
  81       "language \"NONE\" all checks for any language can be disabled.";
  82     }
  83
  84   cmTypeMacro(cmProjectCommand, cmCommand);
  85 };
  86
  87
  88
  89 #endif