Source/CTest/cmCTestMemCheckCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmCTestMemCheckCommand.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 cmCTestMemCheckCommand_h
  18 #define cmCTestMemCheckCommand_h
  19
  20 #include "cmCTestTestCommand.h"
  21
  22 class cmCTestGenericHandler;
  23
  24 /** \class cmCTestMemCheck
  25  * \brief Run a ctest script
  26  *
  27  * cmCTestMemCheckCommand defineds the command to test the project.
  28  */
  29 class cmCTestMemCheckCommand : public cmCTestTestCommand
  30 {
  31 public:
  32
  33   cmCTestMemCheckCommand() {}
  34
  35   /**
  36    * This is a virtual constructor for the command.
  37    */
  38   virtual cmCommand* Clone()
  39     {
  40     cmCTestMemCheckCommand* ni = new cmCTestMemCheckCommand;
  41     ni->CTest = this->CTest;
  42     ni->CTestScriptHandler = this->CTestScriptHandler;
  43     return ni;
  44     }
  45
  46   /**
  47    * The name of the command as specified in CMakeList.txt.
  48    */
  49   virtual const char* GetName() { return "ctest_memcheck";}
  50
  51   /**
  52    * Succinct documentation.
  53    */
  54   virtual const char* GetTerseDocumentation()
  55     {
  56     return "Run tests with a dynamic analysis tool.";
  57     }
  58
  59   /**
  60    * More documentation.
  61    */
  62   virtual const char* GetFullDocumentation()
  63     {
  64     return
  65       "  ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND])\n"
  66       "Performs a memory checking of tests in the given build directory and "
  67       "stores results in MemCheck.xml. The second argument is a variable "
  68       "that will hold value."
  69       "\n"
  70       CTEST_COMMAND_APPEND_OPTION_DOCS;
  71     }
  72
  73   cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand);
  74
  75 protected:
  76   cmCTestGenericHandler* InitializeActualHandler();
  77 };
  78
  79
  80 #endif
  81