Source/CTest/cmCTestHandlerCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestHandlerCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-02-20 20:51:03 $
   7   Version:   $Revision: 1.7 $
   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 cmCTestHandlerCommand_h
  18 #define cmCTestHandlerCommand_h
  19
  20 #include "cmCTestCommand.h"
  21
  22 class cmCTestGenericHandler;
  23
  24 /** \class cmCTestHandler
  25  * \brief Run a ctest script
  26  *
  27  * cmCTestHandlerCommand defineds the command to test the project.
  28  */
  29 class cmCTestHandlerCommand : public cmCTestCommand
  30 {
  31 public:
  32   cmCTestHandlerCommand();
  33
  34   /**
  35    * This is called when the command is first encountered in
  36    * the CMakeLists.txt file.
  37    */
  38   virtual bool InitialPass(std::vector<std::string> const& args,
  39                            cmExecutionStatus &status);
  40
  41   cmTypeMacro(cmCTestHandlerCommand, cmCTestCommand);
  42
  43   enum
  44     {
  45     ct_NONE,
  46     ct_RETURN_VALUE,
  47     ct_BUILD,
  48     ct_SOURCE,
  49     ct_SUBMIT_INDEX,
  50     ct_LAST
  51     };
  52
  53 protected:
  54   virtual cmCTestGenericHandler* InitializeHandler() = 0;
  55
  56   // Command argument handling.
  57   virtual bool CheckArgumentKeyword(std::string const& arg);
  58   virtual bool CheckArgumentValue(std::string const& arg);
  59   enum
  60   {
  61     ArgumentDoingNone,
  62     ArgumentDoingError,
  63     ArgumentDoingKeyword,
  64     ArgumentDoingLast1
  65   };
  66   int ArgumentDoing;
  67   unsigned int ArgumentIndex;
  68
  69   bool AppendXML;
  70
  71   std::string ReturnVariable;
  72   std::vector<const char*> Arguments;
  73   std::vector<const char*> Values;
  74   size_t Last;
  75 };
  76
  77 #define CTEST_COMMAND_APPEND_OPTION_DOCS \
  78   "The APPEND option marks results for append to those previously " \
  79   "submitted to a dashboard server since the last ctest_start.  " \
  80   "Append semantics are defined by the dashboard server in use."
  81
  82 #endif