CMakeLua/Source/cmGetTargetPropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetTargetPropertyCommand.h,v $
   5   Language:  C++
   6 <<<<<<< cmGetTargetPropertyCommand.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.12 $
   9 =======
  10   Date:      $Date: 2009-01-05 14:53:22 $
  11   Version:   $Revision: 1.13 $
  12 >>>>>>> 1.13
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmGetTargetPropertyCommand_h
  23 #define cmGetTargetPropertyCommand_h
  24
  25 #include "cmCommand.h"
  26
  27 class cmGetTargetPropertyCommand : public cmCommand
  28 {
  29 public:
  30   virtual cmCommand* Clone()
  31     {
  32       return new cmGetTargetPropertyCommand;
  33     }
  34
  35   /**
  36    * This is called when the command is first encountered in
  37    * the input file.
  38    */
  39   virtual bool InitialPass(std::vector<std::string> const& args,
  40                            cmExecutionStatus &status);
  41
  42   /**
  43    * The name of the command as specified in CMakeList.txt.
  44    */
  45   virtual const char* GetName() { return "get_target_property";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation()
  51     {
  52     return "Get a property from a target.";
  53     }
  54
  55   /**
  56    * Longer documentation.
  57    */
  58   virtual const char* GetFullDocumentation()
  59     {
  60       return
  61         "  get_target_property(VAR target property)\n"
  62         "Get a property from a target.   The value of the property is "
  63         "stored in the variable VAR.  If the property is not found, VAR "
  64         "will be set to \"NOTFOUND\".  Use set_target_properties to set "
  65         "property values.  Properties are usually used to control how "
  66         "a target is built, but some query the target instead.  "
  67         "This command can get properties for any target so far created. "
  68         "The targets do not need to be in the current CMakeLists.txt file.";
  69     }
  70
  71   cmTypeMacro(cmGetTargetPropertyCommand, cmCommand);
  72 };
  73
  74
  75
  76 #endif