Source/CTest/cmCTestReadCustomFilesCommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc.
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmCTestReadCustomFilesCommand_h
  13 #define cmCTestReadCustomFilesCommand_h
  14
  15 #include "cmCTestCommand.h"
  16
  17 /** \class cmCTestReadCustomFiles
  18  * \brief Run a ctest script
  19  *
  20  * cmLibrarysCommand defines a list of executable (i.e., test)
  21  * programs to create.
  22  */
  23 class cmCTestReadCustomFilesCommand : public cmCTestCommand
  24 {
  25 public:
  26
  27   cmCTestReadCustomFilesCommand() {}
  28
  29   /**
  30    * This is a virtual constructor for the command.
  31    */
  32   virtual cmCommand* Clone()
  33     {
  34     cmCTestReadCustomFilesCommand* ni = new cmCTestReadCustomFilesCommand;
  35     ni->CTest = this->CTest;
  36     return ni;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args,
  44                            cmExecutionStatus &status);
  45
  46   /**
  47    * The name of the command as specified in CMakeList.txt.
  48    */
  49   virtual const char* GetName() const { return "ctest_read_custom_files";}
  50
  51   /**
  52    * Succinct documentation.
  53    */
  54   virtual const char* GetTerseDocumentation() const
  55     {
  56     return "read CTestCustom files.";
  57     }
  58
  59   /**
  60    * More documentation.
  61    */
  62   virtual const char* GetFullDocumentation() const
  63     {
  64     return
  65       "  ctest_read_custom_files( directory ... )\n"
  66       "Read all the CTestCustom.ctest or CTestCustom.cmake files from "
  67       "the given directory.";
  68     }
  69
  70   cmTypeMacro(cmCTestReadCustomFilesCommand, cmCTestCommand);
  71
  72 };
  73
  74
  75 #endif