Source/cmGetCMakePropertyCommand.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 cmGetCMakePropertyCommand_h
  13 #define cmGetCMakePropertyCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 class cmGetCMakePropertyCommand : public cmCommand
  18 {
  19 public:
  20   virtual cmCommand* Clone()
  21     {
  22       return new cmGetCMakePropertyCommand;
  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    * This determines if the command is invoked when in script mode.
  34    */
  35   virtual bool IsScriptable() const { return true; }
  36
  37   /**
  38    * The name of the command as specified in CMakeList.txt.
  39    */
  40   virtual const char* GetName() const { return "get_cmake_property";}
  41
  42   /**
  43    * Succinct documentation.
  44    */
  45   virtual const char* GetTerseDocumentation() const
  46     {
  47     return "Get a property of the CMake instance.";
  48     }
  49
  50   /**
  51    * Longer documentation.
  52    */
  53   virtual const char* GetFullDocumentation() const
  54     {
  55       return
  56         "  get_cmake_property(VAR property)\n"
  57         "Get a property from the CMake instance.  "
  58         "The value of the property is stored in the variable VAR.  "
  59         "If the property is not found, VAR will be set to \"NOTFOUND\".  "
  60         "Some supported properties "
  61         "include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and "
  62         "COMPONENTS."
  63         "\n"
  64         "See also the more general get_property() command.";
  65     }
  66
  67   cmTypeMacro(cmGetCMakePropertyCommand, cmCommand);
  68 };
  69
  70
  71
  72 #endif