CMakeLua/Source/CTest/cmCTestUpdateCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestUpdateCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-03-20 18:19:55 $
   7   Version:   $Revision: 1.8 $
   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 cmCTestUpdateCommand_h
  18 #define cmCTestUpdateCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 /** \class cmCTestUpdate
  23  * \brief Run a ctest script
  24  *
  25  * cmCTestUpdateCommand defineds the command to updates the repository.
  26  */
  27 class cmCTestUpdateCommand : public cmCTestHandlerCommand
  28 {
  29 public:
  30
  31   cmCTestUpdateCommand() {}
  32
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     cmCTestUpdateCommand* ni = new cmCTestUpdateCommand;
  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_update";}
  48
  49   /**
  50    * Succinct documentation.
  51    */
  52   virtual const char* GetTerseDocumentation()
  53     {
  54     return "Update the work tree from version control.";
  55     }
  56
  57   /**
  58    * More documentation.
  59    */
  60   virtual const char* GetFullDocumentation()
  61     {
  62     return
  63       "  ctest_update([SOURCE source] [RETURN_VALUE res])\n"
  64       "Updates the given source directory and stores results in Update.xml. "
  65       "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
  66       "The RETURN_VALUE option specifies a variable in which to store the "
  67       "result, which is the number of files updated or -1 on error."
  68       ;
  69     }
  70
  71   cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand);
  72
  73 protected:
  74   cmCTestGenericHandler* InitializeHandler();
  75 };
  76
  77
  78 #endif