Source/CTest/cmCTestConfigureCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestConfigureCommand.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 cmCTestConfigureCommand_h
  18 #define cmCTestConfigureCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 /** \class cmCTestConfigure
  23  * \brief Run a ctest script
  24  *
  25  * cmCTestConfigureCommand defineds the command to configures the project.
  26  */
  27 class cmCTestConfigureCommand : public cmCTestHandlerCommand
  28 {
  29 public:
  30
  31   cmCTestConfigureCommand() {}
  32
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     cmCTestConfigureCommand* ni = new cmCTestConfigureCommand;
  39     ni->CTest = this->CTest;
  40     ni->CTestScriptHandler = this->CTestScriptHandler;
  41     return ni;
  42     }
  43
  44   /**
  45    * The name of the command as specified in CMakeList.txt.
  46    */
  47   virtual const char* GetName() { return "CTEST_CONFIGURE";}
  48
  49   /**
  50    * Succinct documentation.
  51    */
  52   virtual const char* GetTerseDocumentation()
  53     {
  54     return "Configures the repository.";
  55     }
  56
  57   /**
  58    * More documentation.
  59    */
  60   virtual const char* GetFullDocumentation()
  61     {
  62     return
  63       "  CTEST_CONFIGURE(BUILD build_dir RETURN_VALUE res)\n"
  64       "Configures the given build directory and stores results in "
  65       "Configure.xml. The second argument is a variable that will hold "
  66       "return value.";
  67     }
  68
  69   cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand);
  70
  71 protected:
  72   cmCTestGenericHandler* InitializeHandler();
  73
  74 };
  75
  76
  77 #endif