Source/cmSetCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmSetCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-03-29 16:04:19 $
   7   Version:   $Revision: 1.6 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 cmSetCommand_h
  18 #define cmSetCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22
  23 /** \class cmSetCommand
  24  * \brief Set a CMAKE variable
  25  *
  26  * cmSetCommand sets a variable to a value with expansion.
  27  */
  28 class cmSetCommand : public cmCommand
  29 {
  30 public:
  31   /**
  32    * This is a virtual constructor for the command.
  33    */
  34   virtual cmCommand* Clone()
  35     {
  36     return new cmSetCommand;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args);
  44
  45   /**
  46    * This determines if the command gets propagated down
  47    * to makefiles located in subdirectories.
  48    */
  49   virtual bool IsInherited() {return true;}
  50
  51   /**
  52    * The name of the command as specified in CMakeList.txt.
  53    */
  54   virtual const char* GetName() {return "SET";}
  55
  56   /**
  57    * Succinct documentation.
  58    */
  59   virtual const char* GetTerseDocumentation()
  60     {
  61     return "Set a CMAKE variable to a value";
  62     }
  63
  64   /**
  65    * More documentation.
  66    */
  67   virtual const char* GetFullDocumentation()
  68     {
  69     return
  70       "SET(VAR [VALUE] [CACHE TYPE DOCSTRING])\n"
  71       "Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR "
  72       "is set to it. If CACHE is present, then the VAR is put in the cache."
  73       " TYPE and DOCSTRING are required.  If TYPE is INTERNAL, then the "
  74       " VALUE is Always written into the cache, replacing any values "
  75       "existing in the cache.  If it is not a CACHE VAR, then this always "
  76       "writes into the current makefile.\n"
  77       "An optional syntax is SET(VAR VALUE1 ... VALUEN).\n"
  78       "In this case VAR is set to a ; separated list of values.";
  79     }
  80
  81   cmTypeMacro(cmSetCommand, cmCommand);
  82 };
  83
  84
  85
  86 #endif