Source/CTest/cmCTestBuildCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestBuildCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-02-20 20:51:02 $
   7   Version:   $Revision: 1.9 $
   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 cmCTestBuildCommand_h
  18 #define cmCTestBuildCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 class cmGlobalGenerator;
  23 class cmCTestBuildHandler;
  24
  25 /** \class cmCTestBuild
  26  * \brief Run a ctest script
  27  *
  28  * cmCTestBuildCommand defineds the command to build the project.
  29  */
  30 class cmCTestBuildCommand : public cmCTestHandlerCommand
  31 {
  32 public:
  33
  34   cmCTestBuildCommand();
  35   ~cmCTestBuildCommand();
  36
  37   /**
  38    * This is a virtual constructor for the command.
  39    */
  40   virtual cmCommand* Clone()
  41     {
  42     cmCTestBuildCommand* ni = new cmCTestBuildCommand;
  43     ni->CTest = this->CTest;
  44     ni->CTestScriptHandler = this->CTestScriptHandler;
  45     return ni;
  46     }
  47
  48   /**
  49    * The name of the command as specified in CMakeList.txt.
  50    */
  51   virtual const char* GetName() { return "ctest_build";}
  52
  53   /**
  54    * Succinct documentation.
  55    */
  56   virtual const char* GetTerseDocumentation()
  57     {
  58     return "Build the project.";
  59     }
  60   virtual bool InitialPass(std::vector<std::string> const& args,
  61                            cmExecutionStatus &status);
  62   /**
  63    * More documentation.
  64    */
  65   virtual const char* GetFullDocumentation()
  66     {
  67     return
  68       "  ctest_build([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n"
  69       "              [NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n"
  70       "Builds the given build directory and stores results in Build.xml. "
  71       "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
  72       "The RETURN_VALUE option specifies a variable in which to store the "
  73       "return value of the native build tool. "
  74       "The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in "
  75       "which to store the number of build errors and warnings detected."
  76       "\n"
  77       CTEST_COMMAND_APPEND_OPTION_DOCS;
  78     }
  79
  80   cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand);
  81
  82   cmGlobalGenerator* GlobalGenerator;
  83
  84 protected:
  85   cmCTestBuildHandler* Handler;
  86   enum {
  87     ctb_BUILD = ct_LAST,
  88     ctb_NUMBER_ERRORS,
  89     ctb_NUMBER_WARNINGS,
  90     ctb_LAST
  91   };
  92
  93   cmCTestGenericHandler* InitializeHandler();
  94 };
  95
  96
  97 #endif