CMakeLua/Source/CTest/cmCTestRunScriptCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestRunScriptCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmCTestRunScriptCommand.h
   7   Date:      $Date: 2008/01/23 15:28:01 $
   8   Version:   $Revision: 1.4 $
   9 =======
  10   Date:      $Date: 2008-05-12 13:11:51 $
  11   Version:   $Revision: 1.5 $
  12 >>>>>>> 1.5
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmCTestRunScriptCommand_h
  23 #define cmCTestRunScriptCommand_h
  24
  25 #include "cmCTestCommand.h"
  26
  27 /** \class cmCTestRunScript
  28  * \brief Run a ctest script
  29  *
  30  * cmLibrarysCommand defines a list of executable (i.e., test)
  31  * programs to create.
  32  */
  33 class cmCTestRunScriptCommand : public cmCTestCommand
  34 {
  35 public:
  36
  37   cmCTestRunScriptCommand() {}
  38
  39   /**
  40    * This is a virtual constructor for the command.
  41    */
  42   virtual cmCommand* Clone()
  43     {
  44     cmCTestRunScriptCommand* ni = new cmCTestRunScriptCommand;
  45     ni->CTest = this->CTest;
  46     ni->CTestScriptHandler = this->CTestScriptHandler;
  47     return ni;
  48     }
  49
  50   /**
  51    * This is called when the command is first encountered in
  52    * the CMakeLists.txt file.
  53    */
  54   virtual bool InitialPass(std::vector<std::string> const& args,
  55                            cmExecutionStatus &status);
  56
  57   /**
  58    * The name of the command as specified in CMakeList.txt.
  59    */
  60   virtual const char* GetName() { return "ctest_run_script";}
  61
  62   /**
  63    * Succinct documentation.
  64    */
  65   virtual const char* GetTerseDocumentation()
  66     {
  67     return "runs a ctest -S script";
  68     }
  69
  70   /**
  71    * More documentation.
  72    */
  73   virtual const char* GetFullDocumentation()
  74     {
  75     return
  76       "  ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 \n"
  77       "              script_file_name2 ...)\n"
  78       "Runs a script or scripts much like if it was run from ctest -S. "
  79       "If no argument is provided then the current script is run using "
  80       "the current settings of the variables. If NEW_PROCESS is specified "
  81       "then each script will be run in a seperate process.";
  82     }
  83
  84   cmTypeMacro(cmCTestRunScriptCommand, cmCTestCommand);
  85
  86 };
  87
  88
  89 #endif