CMakeLua/Source/CTest/cmCTestBuildCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestBuildCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/03/29 17:01:24 $
   7   Version:   $Revision: 1.5 $
   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 cmCTestBuildCommand_h
  18 #define cmCTestBuildCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 class cmGlobalGenerator;
  23
  24 /** \class cmCTestBuild
  25  * \brief Run a ctest script
  26  *
  27  * cmCTestBuildCommand defineds the command to build the project.
  28  */
  29 class cmCTestBuildCommand : public cmCTestHandlerCommand
  30 {
  31 public:
  32
  33   cmCTestBuildCommand();
  34   ~cmCTestBuildCommand();
  35
  36   /**
  37    * This is a virtual constructor for the command.
  38    */
  39   virtual cmCommand* Clone()
  40     {
  41     cmCTestBuildCommand* ni = new cmCTestBuildCommand;
  42     ni->CTest = this->CTest;
  43     ni->CTestScriptHandler = this->CTestScriptHandler;
  44     return ni;
  45     }
  46
  47   /**
  48    * The name of the command as specified in CMakeList.txt.
  49    */
  50   virtual const char* GetName() { return "CTEST_BUILD";}
  51
  52   /**
  53    * Succinct documentation.
  54    */
  55   virtual const char* GetTerseDocumentation()
  56     {
  57     return "Builds the repository.";
  58     }
  59
  60   /**
  61    * More documentation.
  62    */
  63   virtual const char* GetFullDocumentation()
  64     {
  65     return
  66       "  CTEST_BUILD([BUILD build_dir] [RETURN_VALUE res])\n"
  67       "Builds the given build directory and stores results in Build.xml.";
  68     }
  69
  70   cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand);
  71
  72   cmGlobalGenerator* GlobalGenerator;
  73
  74 protected:
  75   cmCTestGenericHandler* InitializeHandler();
  76 };
  77
  78
  79 #endif