Source/cmGetTargetPropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetTargetPropertyCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-12-21 16:14:47 $
   7   Version:   $Revision: 1.1 $
   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 cmGetTargetPropertyCommand_h
  18 #define cmGetTargetPropertyCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 class cmGetTargetPropertyCommand : public cmCommand
  24 {
  25 public:
  26   virtual cmCommand* Clone()
  27     {
  28       return new cmGetTargetPropertyCommand;
  29     }
  30
  31   /**
  32    * This is called when the command is first encountered in
  33    * the input file.
  34    */
  35   virtual bool InitialPass(std::vector<std::string> const& args);
  36
  37   /**
  38    * The name of the command as specified in CMakeList.txt.
  39    */
  40   virtual const char* GetName() { return "GET_TARGET_PROPERTY";}
  41
  42   /**
  43    * Succinct documentation.
  44    */
  45   virtual const char* GetTerseDocumentation()
  46     {
  47     return "Get a property for a file";
  48     }
  49
  50   /**
  51    * Longer documentation.
  52    */
  53   virtual const char* GetFullDocumentation()
  54     {
  55       return
  56         "GET_TARGET_PROPERTY(VAR target property) "
  57         "Get a property from a source file.   The value of the property is "
  58         " stored in the variable VAR. If the property is not found, var "
  59         "will be set to NOT_FOUND";
  60     }
  61
  62   cmTypeMacro(cmGetTargetPropertyCommand, cmCommand);
  63 };
  64
  65
  66
  67 #endif