CMakeLua/Source/CTest/cmCTestCoverageCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestCoverageCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2009-03-05 15:17:42 $
   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 cmCTestCoverageCommand_h
  18 #define cmCTestCoverageCommand_h
  19
  20 #include "cmCTestHandlerCommand.h"
  21
  22 /** \class cmCTestCoverage
  23  * \brief Run a ctest script
  24  *
  25  * cmCTestCoverageCommand defineds the command to test the project.
  26  */
  27 class cmCTestCoverageCommand : public cmCTestHandlerCommand
  28 {
  29 public:
  30
  31   cmCTestCoverageCommand();
  32
  33   /**
  34    * This is a virtual constructor for the command.
  35    */
  36   virtual cmCommand* Clone()
  37     {
  38     cmCTestCoverageCommand* ni = new cmCTestCoverageCommand;
  39     ni->CTest = this->CTest;
  40     ni->CTestScriptHandler = this->CTestScriptHandler;
  41     return ni;
  42     }
  43
  44   /**
  45    * The name of the command as specified in CMakeList.txt.
  46    */
  47   virtual const char* GetName() { return "ctest_coverage";}
  48
  49   /**
  50    * Succinct documentation.
  51    */
  52   virtual const char* GetTerseDocumentation()
  53     {
  54     return "Collect coverage tool results.";
  55     }
  56
  57   /**
  58    * More documentation.
  59    */
  60   virtual const char* GetFullDocumentation()
  61     {
  62     return
  63       "  ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n"
  64       "                 [LABELS label1 [label2 [...]]])\n"
  65       "Perform the coverage of the given build directory and stores results "
  66       "in Coverage.xml. The second argument is a variable that will hold "
  67       "value."
  68       "\n"
  69       "The LABELS option filters the coverage report to include only "
  70       "source files labeled with at least one of the labels specified."
  71       "\n"
  72       CTEST_COMMAND_APPEND_OPTION_DOCS;
  73     }
  74
  75   cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand);
  76
  77 protected:
  78   cmCTestGenericHandler* InitializeHandler();
  79
  80   virtual bool CheckArgumentKeyword(std::string const& arg);
  81   virtual bool CheckArgumentValue(std::string const& arg);
  82
  83   enum
  84   {
  85     ArgumentDoingLabels = Superclass::ArgumentDoingLast1,
  86     ArgumentDoingLast2
  87   };
  88
  89   bool LabelsMentioned;
  90   std::set<cmStdString> Labels;
  91 };
  92
  93
  94 #endif
  95