Source/cmProjectCommand.h

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