CMakeLua/Source/CTest/cmCTestReadCustomFilesCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestReadCustomFilesCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/03/10 20:03:09 $
   7   Version:   $Revision: 1.2 $
   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 cmCTestReadCustomFilesCommand_h
  18 #define cmCTestReadCustomFilesCommand_h
  19
  20 #include "cmCTestCommand.h"
  21
  22 /** \class cmCTestReadCustomFiles
  23  * \brief Run a ctest script
  24  *
  25  * cmLibrarysCommand defines a list of executable (i.e., test)
  26  * programs to create.
  27  */
  28 class cmCTestReadCustomFilesCommand : public cmCTestCommand
  29 {
  30 public:
  31
  32   cmCTestReadCustomFilesCommand() {}
  33
  34   /**
  35    * This is a virtual constructor for the command.
  36    */
  37   virtual cmCommand* Clone()
  38     {
  39     cmCTestReadCustomFilesCommand* ni = new cmCTestReadCustomFilesCommand;
  40     ni->CTest = this->CTest;
  41     return ni;
  42     }
  43
  44   /**
  45    * This is called when the command is first encountered in
  46    * the CMakeLists.txt file.
  47    */
  48   virtual bool InitialPass(std::vector<std::string> const& args,
  49                            cmExecutionStatus &status);
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() { return "ctest_read_custom_files";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "read CTestCustom files.";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "  ctest_read_custom_files( directory ... )\n"
  71       "Read all the CTestCustom.ctest or CTestCustom.cmake files from "
  72       "the given directory.";
  73     }
  74
  75   cmTypeMacro(cmCTestReadCustomFilesCommand, cmCTestCommand);
  76
  77 };
  78
  79
  80 #endif