Source/cmProjectCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmProjectCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-04-02 20:42:13 $
   7   Version:   $Revision: 1.8 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmProjectCommand
  24  * \brief Specify the name for this build project.
  25  *
  26  * cmProjectCommand is used to specify a name for this build project.
  27  * It is defined once per set of CMakeList.txt files (including
  28  * all subdirectories). Currently it just sets the name of the workspace
  29  * file for Microsoft Visual C++
  30  */
  31 class cmProjectCommand : public cmCommand
  32 {
  33 public:
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     return new cmProjectCommand;
  40     }
  41
  42   /**
  43    * This is called when the command is first encountered in
  44    * the CMakeLists.txt file.
  45    */
  46   virtual bool InitialPass(std::vector<std::string> const& args);
  47
  48   /**
  49    * The name of the command as specified in CMakeList.txt.
  50    */
  51   virtual const char* GetName() {return "PROJECT";}
  52
  53   /**
  54    * This determines if the command gets propagated down
  55    * to makefiles located in subdirectories.
  56    */
  57   virtual bool IsInherited()
  58     {
  59     return true;
  60     }
  61
  62   /**
  63    * Succinct documentation.
  64    */
  65   virtual const char* GetTerseDocumentation()
  66     {
  67     return "Set a name for the entire project. One argument.";
  68     }
  69
  70   /**
  71    * More documentation.
  72    */
  73   virtual const char* GetFullDocumentation()
  74     {
  75     return
  76       "PROJECT(projectname [C++ C Java])\n"
  77       "Sets the name of the project.  "
  78       "This creates the variables projectname_BINARY_DIR and projectname_SOURCE_DIR.  "
  79       "Optionally you can specify which languages your project supports.  "
  80       "By default all languages are supported.  If you do not have a C++ compiler, but want"
  81       " to build a c program with cmake, then use this option.";
  82     }
  83
  84   cmTypeMacro(cmProjectCommand, cmCommand);
  85 };
  86
  87
  88
  89 #endif