Source/cmGetTargetPropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmGetTargetPropertyCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.12 $
   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 "cmCommand.h"
  21
  22 class cmGetTargetPropertyCommand : public cmCommand
  23 {
  24 public:
  25   virtual cmCommand* Clone()
  26     {
  27       return new cmGetTargetPropertyCommand;
  28     }
  29
  30   /**
  31    * This is called when the command is first encountered in
  32    * the input file.
  33    */
  34   virtual bool InitialPass(std::vector<std::string> const& args,
  35                            cmExecutionStatus &status);
  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 from a target.";
  48     }
  49
  50   /**
  51    * Longer documentation.
  52    */
  53   virtual const char* GetFullDocumentation()
  54     {
  55       return
  56         "  get_target_property(VAR target property)\n"
  57         "Get a property from a target.   The value of the property is "
  58         "stored in the variable VAR.  If the property is not found, VAR "
  59         "will be set to \"NOTFOUND\".  Use set_target_properties to set "
  60         "property values.  Properties are usually used to control how "
  61         "a target is built.\n"
  62         "The read-only property \"<CONFIG>_LOCATION\" provides the full "
  63         "path to the file on disk that will be created for the target when "
  64         "building under configuration <CONFIG> "
  65         "(in upper-case, such as \"DEBUG_LOCATION\"). "
  66         "The read-only property \"LOCATION\" specifies "
  67         "the full path to the file on disk that will be created for the "
  68         "target. The path may contain a build-system-specific portion that "
  69         "is replaced at build time with the configuration getting built "
  70         "(such as \"$(ConfigurationName)\" in VS). "
  71         "This is very useful for executable targets to get "
  72         "the path to the executable file for use in a custom command.\n"
  73         "The read-only property \"TYPE\" returns which type the specified "
  74         "target has (EXECUTABLE, STATIC_LIBRARY, SHARED_LIBRARY, "
  75         "MODULE_LIBRARY, UTILITY, INSTALL_FILES or INSTALL_PROGRAMS). "
  76         "This command can get properties for any target so far created. "
  77         "The targets do not need to be in the current CMakeLists.txt file.";
  78     }
  79
  80   cmTypeMacro(cmGetTargetPropertyCommand, cmCommand);
  81 };
  82
  83
  84
  85 #endif