Source/cmDefinePropertyCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDefinePropertyCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.5 $
   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 cmDefinesPropertyCommand_h
  18 #define cmDefinesPropertyCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 class cmDefinePropertyCommand : public cmCommand
  23 {
  24 public:
  25   virtual cmCommand* Clone()
  26     {
  27       return new cmDefinePropertyCommand;
  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 "define_property";}
  41
  42   /**
  43    * Succinct documentation.
  44    */
  45   virtual const char* GetTerseDocumentation()
  46     {
  47     return "Define properties used by CMake.";
  48     }
  49
  50   /**
  51    * Longer documentation.
  52    */
  53   virtual const char* GetFullDocumentation()
  54     {
  55       return
  56         "  define_property(property_name scope_value\n"
  57         "                  short_description\n"
  58         "                  full_description inherit)\n"
  59         "Define a property for a scope. scope_value is either GLOBAL, "
  60         "DIRECTORY, TARGET, TEST, SOURCE_FILE, VARIABLE or CACHED_VARIABLE. "
  61         "The short and full descriptions are used to document the property. "
  62         "If inherit is TRUE, it will inherit its value from the next more "
  63         "global property if it hasn't been set at the specified scope. "
  64         "This means that e.g. a TARGET property inherits it's value from the "
  65         "DIRECTORY property with the same name if it hasn't been set for the "
  66         "target, and then from GLOBAL if it hasn't been set for the directory."
  67         ;
  68     }
  69
  70   cmTypeMacro(cmDefinePropertyCommand, cmCommand);
  71 };
  72
  73
  74
  75 #endif