Source/CTest/cmCTestRunScriptCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestRunScriptCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-05-12 13:11:51 $
   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 cmCTestRunScriptCommand_h
  18 #define cmCTestRunScriptCommand_h
  19
  20 #include "cmCTestCommand.h"
  21
  22 /** \class cmCTestRunScript
  23  * \brief Run a ctest script
  24  *
  25  * cmLibrarysCommand defines a list of executable (i.e., test)
  26  * programs to create.
  27  */
  28 class cmCTestRunScriptCommand : public cmCTestCommand
  29 {
  30 public:
  31
  32   cmCTestRunScriptCommand() {}
  33
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     cmCTestRunScriptCommand* ni = new cmCTestRunScriptCommand;
  40     ni->CTest = this->CTest;
  41     ni->CTestScriptHandler = this->CTestScriptHandler;
  42     return ni;
  43     }
  44
  45   /**
  46    * This is called when the command is first encountered in
  47    * the CMakeLists.txt file.
  48    */
  49   virtual bool InitialPass(std::vector<std::string> const& args,
  50                            cmExecutionStatus &status);
  51
  52   /**
  53    * The name of the command as specified in CMakeList.txt.
  54    */
  55   virtual const char* GetName() { return "ctest_run_script";}
  56
  57   /**
  58    * Succinct documentation.
  59    */
  60   virtual const char* GetTerseDocumentation()
  61     {
  62     return "runs a ctest -S script";
  63     }
  64
  65   /**
  66    * More documentation.
  67    */
  68   virtual const char* GetFullDocumentation()
  69     {
  70     return
  71       "  ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 \n"
  72       "              script_file_name2 ...)\n"
  73       "Runs a script or scripts much like if it was run from ctest -S. "
  74       "If no argument is provided then the current script is run using "
  75       "the current settings of the variables. If NEW_PROCESS is specified "
  76       "then each script will be run in a seperate process.";
  77     }
  78
  79   cmTypeMacro(cmCTestRunScriptCommand, cmCTestCommand);
  80
  81 };
  82
  83
  84 #endif