Source/cmGetTestPropertyCommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   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 cmGetTestPropertyCommand_h
  13 #define cmGetTestPropertyCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 class cmGetTestPropertyCommand : public cmCommand
  18 {
  19 public:
  20   virtual cmCommand* Clone()
  21     {
  22     return new cmGetTestPropertyCommand;
  23     }
  24
  25   /**
  26    * This is called when the command is first encountered in
  27    * the input file.
  28    */
  29   virtual bool InitialPass(std::vector<std::string> const& args,
  30                            cmExecutionStatus &status);
  31
  32   /**
  33    * The name of the command as specified in CMakeList.txt.
  34    */
  35   virtual const char* GetName() const { return "get_test_property";}
  36
  37   /**
  38    * Succinct documentation.
  39    */
  40   virtual const char* GetTerseDocumentation() const
  41     {
  42     return "Get a property of the test.";
  43     }
  44
  45   /**
  46    * Longer documentation.
  47    */
  48   virtual const char* GetFullDocumentation() const
  49     {
  50     return
  51       "  get_test_property(test property VAR)\n"
  52       "Get a property from the Test.  The value of the property is "
  53       "stored in the variable VAR.  If the property is not found, VAR "
  54       "will be set to \"NOTFOUND\". For a list of standard properties "
  55       "you can type cmake --help-property-list"
  56       "\n"
  57       "See also the more general get_property() command.";
  58     }
  59
  60   cmTypeMacro(cmGetTestPropertyCommand, cmCommand);
  61 };
  62
  63
  64
  65 #endif