CMakeLua/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestEmptyBinaryDirectoryCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmCTestEmptyBinaryDirectoryCommand.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 cmCTestEmptyBinaryDirectoryCommand_h
  23 #define cmCTestEmptyBinaryDirectoryCommand_h
  24
  25 #include "cmCTestCommand.h"
  26
  27 /** \class cmCTestEmptyBinaryDirectory
  28  * \brief Run a ctest script
  29  *
  30  * cmLibrarysCommand defines a list of executable (i.e., test)
  31  * programs to create.
  32  */
  33 class cmCTestEmptyBinaryDirectoryCommand : public cmCTestCommand
  34 {
  35 public:
  36
  37   cmCTestEmptyBinaryDirectoryCommand() {}
  38
  39   /**
  40    * This is a virtual constructor for the command.
  41    */
  42   virtual cmCommand* Clone()
  43     {
  44     cmCTestEmptyBinaryDirectoryCommand* ni
  45       = new cmCTestEmptyBinaryDirectoryCommand;
  46     ni->CTest = this->CTest;
  47     ni->CTestScriptHandler = this->CTestScriptHandler;
  48     return ni;
  49     }
  50
  51   /**
  52    * This is called when the command is first encountered in
  53    * the CMakeLists.txt file.
  54    */
  55   virtual bool InitialPass(std::vector<std::string> const& args,
  56                            cmExecutionStatus &status);
  57
  58   /**
  59    * The name of the command as specified in CMakeList.txt.
  60    */
  61   virtual const char* GetName() { return "ctest_empty_binary_directory";}
  62
  63   /**
  64    * Succinct documentation.
  65    */
  66   virtual const char* GetTerseDocumentation()
  67     {
  68     return "empties the binary directory";
  69     }
  70
  71   /**
  72    * More documentation.
  73    */
  74   virtual const char* GetFullDocumentation()
  75     {
  76     return
  77       "  ctest_empty_binary_directory( directory )\n"
  78       "Removes a binary directory. This command will perform some checks "
  79       "prior to deleting the directory in an attempt to avoid malicious "
  80       "or accidental directory deletion.";
  81     }
  82
  83   cmTypeMacro(cmCTestEmptyBinaryDirectoryCommand, cmCTestCommand);
  84
  85 };
  86
  87
  88 #endif