CMakeLua/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: 2009-02-20 20:51:03 $
   7   Version:   $Revision: 1.9 $
   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   cmCTestConfigureCommand();
  31
  32   /**
  33    * This is a virtual constructor for the command.
  34    */
  35   virtual cmCommand* Clone()
  36     {
  37     cmCTestConfigureCommand* ni = new cmCTestConfigureCommand;
  38     ni->CTest = this->CTest;
  39     ni->CTestScriptHandler = this->CTestScriptHandler;
  40     return ni;
  41     }
  42
  43   /**
  44    * The name of the command as specified in CMakeList.txt.
  45    */
  46   virtual const char* GetName() { return "ctest_configure";}
  47
  48   /**
  49    * Succinct documentation.
  50    */
  51   virtual const char* GetTerseDocumentation()
  52     {
  53     return "Configure the project build tree.";
  54     }
  55
  56   /**
  57    * More documentation.
  58    */
  59   virtual const char* GetFullDocumentation()
  60     {
  61     return
  62       "  ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]\n"
  63       "                  [OPTIONS options] [RETURN_VALUE res])\n"
  64       "Configures the given build directory and stores results in "
  65       "Configure.xml. "
  66       "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
  67       "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
  68       "The OPTIONS argument specifies command line arguments to pass to "
  69       "the configuration tool. "
  70       "The RETURN_VALUE option specifies a variable in which to store the "
  71       "return value of the native build tool."
  72       "\n"
  73       CTEST_COMMAND_APPEND_OPTION_DOCS;
  74     }
  75
  76   cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand);
  77
  78 protected:
  79   cmCTestGenericHandler* InitializeHandler();
  80
  81   enum {
  82     ctc_FIRST = ct_LAST,
  83     ctc_OPTIONS,
  84     ctc_LAST
  85   };
  86 };
  87
  88
  89 #endif